C# Class DotNetXri.Syntax.Parsable

This class provides a base class for all classes that are parsed according to the XRI Syntax definition.
Inheritance: IComparable
Show file Open project: AArnott/dotnetxri

Protected Properties

Property Type Description
mbParseResult bool
mbParsed bool
msValue string

Public Methods

Method Description
Equals ( object obj ) : bool
GetHashCode ( ) : int
ToString ( ) : string

Outputs the obj according to the XRI Syntax defined for this obj

compareTo ( Object obj ) : int
scan ( ParseStream oParseStream ) : bool

Scans the stream for parts that can be parsed into the obj

Protected Methods

Method Description
Parsable ( ) : System

Protected Constructor used by package only

Parsable ( string value ) : System

Constructs Parsable obj from a String

doScan ( ParseStream oParseStream ) : bool

Scans the stream for parts that can be parsed into the obj

parse ( ) : void

Parses the set value.

Throws XRIParseException if entire value could not be parsed into the obj

setParsedValue ( string value ) : void

Sets the parsed value for the obj

Private Methods

Method Description
setValue ( string value ) : void

Method Details

Equals() public method

public Equals ( object obj ) : bool
obj object
return bool

GetHashCode() public method

public GetHashCode ( ) : int
return int

Parsable() protected method

Protected Constructor used by package only
protected Parsable ( ) : System
return System

Parsable() protected method

Constructs Parsable obj from a String
protected Parsable ( string value ) : System
value string
return System

ToString() public method

Outputs the obj according to the XRI Syntax defined for this obj
public ToString ( ) : string
return string

compareTo() public method

public compareTo ( Object obj ) : int
obj Object
return int

doScan() protected abstract method

Scans the stream for parts that can be parsed into the obj
protected abstract doScan ( ParseStream oParseStream ) : bool
oParseStream ParseStream The input stream to read from
return bool

parse() protected method

Parses the set value.
Throws XRIParseException if entire value could not be parsed into the obj
protected parse ( ) : void
return void

scan() public method

Scans the stream for parts that can be parsed into the obj
public scan ( ParseStream oParseStream ) : bool
oParseStream ParseStream The input stream to read from
return bool

setParsedValue() protected method

Sets the parsed value for the obj
protected setParsedValue ( string value ) : void
value string The value to set the obj to
return void

Property Details

mbParseResult protected property

protected bool mbParseResult
return bool

mbParsed protected property

protected bool mbParsed
return bool

msValue protected property

protected string msValue
return string