class JsonValue in Tinman.Core.Formatting

Helper object for parsing formatted JSON values.

`sealed class`	`JsonValue`	`implements`	`ICodeOutput`
			`IEquatable<JsonValue>`
			`ISerializable`

Remarks

A formatted JSON value must be written in the following Grammar:

json     := value ;

array    := '[' (value .. ',')? ']' ;
member   := string ':' value ;
object   := '{' ((comment)* member .. ',')? '}' ;
value    := 'false' | 'null' | 'true' | object | array | number | string ;

string   := '"' (]"\\[ | escape)* '"' ;

escape   := '\\' ([/tfbn"r\\] | 'u' hexdigit[4]) ;

hexdigit := 'a'..'f' | 'A'..'F' | digit ;
number   := '-'? ('0' | '1'..'9' digit*) ('.' digit+)? (('e' | 'E') ('+' | '-')? digit+)? ;

comment  := '// ' ]\r\n[* '\r'? '\n' ;
digit    := '0'..'9' ;

Serialization

SerialId

Serialization information about this type.

`public static readonly field`	`SerialId`
`type`	`ISerialTypeInfo`

Public / Constants

Null

The null JSON value.

`public static readonly field`	`Null`
`type`	`JsonValue`

Public / Attributes

Count

Returns the number of array elements or object members in this JSON value.

`public property`	`Count { get }`
`type`	`int32`
`value`	`[>=0]`	The number of aggregated values.

Elements

Returns the array elements of this JSON value.

`public property`	`Elements { get }`
`type`	`IVectorConst<JsonValue>`
`value`	`[not-null]`	The list of array elements. Will be empty is IsArray returns `false`.

IsBoolean

Is this JSON value of type boolean?

`public property`	`IsBoolean { get }`
`type`	`bool`
`value`		`true` if this JSON value is of type `boolean`, `false` if not.

IsInteger

Is this JSON value of type integer?

`public property`	`IsInteger { get }`
`type`	`bool`
`value`		`true` if this JSON value is of type `integer`, `false` if not.

IsNull

Is this JSON value null?

`public property`	`IsNull { get }`
`type`	`bool`
`value`		`true` if this JSON value is `null`, `false` if not.

IsNumber

Is this JSON value of type number?

`public property`	`IsNumber { get }`
`type`	`bool`
`value`		`true` if this JSON value is of type `number`, `false` if not.

IsObject

Is this JSON value of type object?

`public property`	`IsObject { get }`
`type`	`bool`
`value`		`true` if this JSON value is of type `object`, `false` if not.

IsString

Is this JSON value of type string?

`public property`	`IsString { get }`
`type`	`bool`
`value`		`true` if this JSON value is of type `string`, `false` if not.

SerialType

Returns the serial type of this object.

`public property`	`SerialType { get }`
`type`	`ISerialTypeInfo`
`value`	`[not-null]`	The serial type.
`implements`	`ISerializable.SerialType`

SerialVersion

Returns the serial data version.

`public property`	`SerialVersion { get }`
`type`	`int32`
`value`	`[>=1]`	The serial data version tag.
`implements`	`ISerializable.SerialVersion`

Remarks:

An ISerializable implementation is required to support all versions up to the one returned by SerialVersion.

See also:

ISerializable.Serialize
ISerializable.Deserialize

Public / Constructors

From

Creates a JsonValue from the given text.

`public static method`	`From (string text)`
`type`	`JsonValue`
`params`	`text`	`[not-null]`	The JSON code.
`returns`		`[not-null]`	The JsonValue object.

FromFile

Creates a new instance of JsonValue from the given file.

`public static method`	`FromFile (Path file)`
`type`	`JsonValue`
`params`	`file`	`[not-null]`	The file path.
`returns`		`[not-null]`	The JsonValue object or Null if the file does not exist.

See also:

ToFile

JsonValue

Creates a new instance of JsonValue.

public constructor JsonValue ()

Public / Methods

Deserialize

Initializes the state of this object from the given data stream.

`public method`	`Deserialize (int32 serialVersion, ISerializer data)`
`type`	`ISerializable`
`params`	`serialVersion`	`[>=1]`	The serial data version.
	`data`	`[not-null]`	The serial data stream.
`returns`		`[not-null]`	The deserialized object. This will typically be `this`, but in some circumstances, another instance may be returned (e.g. singletons).
`implements`	`ISerializable.Deserialize`

Remarks:

The Deserialize method will be called immediately after the object has been instantiated via its default constructor.

The provided serialVersion number is guaranteed to be equal to or less than the SerialVersion returned by this object (i.e. ISerializable object must provide backwards compatibility).

See also:

ISerializable.Serialize
ISerializable.SerialVersion