public class | source

ModelNode

A dynamic model representation node object.

Static Method Summary

Static Public Methods
public static	create(): ModelNode Creates a new undefined model node
public static	fromBase64(encoded: string): ModelNode Creates a new node from a base64 encoded string

Member Summary

Public Members
public get	defined: boolean Determine whether this node is defined.
public get	failure: boolean
public get	failureDescription: string

Method Summary

Public Methods
public	add(): ModelNode Add a node to the end of this node's value list and return it. If the node is undefined, it will be initialized to be of type list.
public	asBoolean(): boolean Get the value of this node as a boolean.
public	asInt(): number Get the value of this node as number.
public	asList(): ModelNode[]
public	asObject(): ModelNode Get a copy of this value as an object.
public	asProperties(): Property[]
public	asProperty(): Property Get the value of this node as a property.
public	asString(): string Get the value as a string.
public	clear(): ModelNode Clear this node's value and change its type to undefined.
public	get(name: string): ModelNode Get the child of this node with the given name.
public	getJSON(): json
public	has(key: string): boolean Determine whether this node has a child with the given name.
public	hasDefined(key: string): boolean Determine whether this node has a defined child with the given name.
public	setBoolean(newValue: boolean): ModelNode Change this node's value to the given value.
public	setEmptyList(): ModelNode Change this node's value to an empty list.
public	setEmptyObject(): ModelNode Change this node's value to an empty object.
public	setExpression(newValue: string): ModelNode Change this node's value to the given expression value.
public	setNode(newValue: ModelNode): ModelNode Change this node's value to the given value. The value is copied from the parameter.
public	setNumber(newValue: number): ModelNode Change this node's value to the given value.
public	setProperty(newValue: Property): ModelNode Change this node's value to the given value.
public	setString(newValue: string): ModelNode Change this node's value to the given value.
public	toBase64String()
public	toString(): string Get a human-readable string representation of this model node, formatted nicely (possibly on multiple lines).

Static Public Methods

public static create(): ModelNode source

Creates a new undefined model node

Return:

ModelNode

the new model node

public static fromBase64(encoded: string): ModelNode source

Creates a new node from a base64 encoded string

Params:

Name	Type	Attribute	Description
encoded	string		The base64 encoded string.

Return:

ModelNode

the new model node

Public Members

public get defined: boolean source

Determine whether this node is defined.

Return:

boolean

true if this node's value is defined, false otherwise

public get failure: boolean source

Return:

boolean

true if this node has an outcome and the outcome does not equal "success"

public get failureDescription: string source

Return:

string

the failure description or "No failure-description provided"

Public Methods

public add(): ModelNode source

Add a node to the end of this node's value list and return it. If the node is undefined, it will be initialized to be of type list.

Return:

ModelNode

the new node

public asBoolean(): boolean source

Get the value of this node as a boolean. Collection types return true for non-empty collections. Numerical types return true for non-zero values.

Return:

boolean

the boolean value

Throw:

*	IllegalArgumentException if no conversion is possible

public asInt(): number source

Get the value of this node as number. Collection types will return the size of the collection for this value. Other types may attempt a string conversion.

Return:

number

the numeric value

Throw:

*	IllegalArgumentException if no conversion is possible

public asList(): ModelNode[] source

Return:

ModelNode[]

this model node as an array.

public asObject(): ModelNode source

Get a copy of this value as an object. Object values will simply copy themselves.

Property values will return a single-entry object whose key and value are copied from the property key and value.

List values will attempt to interpolate the list into an object by iterating each item, mapping each property into an object entry and otherwise taking pairs of list entries, converting the first to a string, and using the pair of entries as a single object entry. If an object key appears more than once in the source object, the last key takes precedence.

Return:

ModelNode

the object value

Throw:

*	IllegalArgumentException if no conversion is possible

public asProperties(): Property[] source

Return:

Property[]

this model node as an Property array

public asProperty(): Property source

Get the value of this node as a property. Object values will return a property if there is exactly one property in the object. List values will return a property if there are exactly two items in the list, and if the first is convertible to a string.

Return:

Property

the property value

Throw:

*	IllegalArgumentException if no conversion is possible

public asString(): string source

Get the value as a string. This is the literal value of this model node. More than one node type may yield the same value for this method.

Return:

string

the string value

public clear(): ModelNode source

Clear this node's value and change its type to undefined.

Return:

ModelNode

this node

public get(name: string): ModelNode source

Get the child of this node with the given name. If no such child exists, create it. If the node is undefined, it will be initialized to be of type object.

When called on property values, the name must match the property name.

Params:

Name	Type	Attribute	Description
name	string		the child name

Return:

ModelNode

the child

Throw:

*	IllegalArgumentException if this node does not support getting a child with the given name

public getJSON(): json source

Return:

json	the model node as JSON

public has(key: string): boolean source

Determine whether this node has a child with the given name. Property node types always contain exactly one value with a key equal to the property name.

Params:

Name	Type	Attribute	Description
key	string		the name

Return:

boolean

true if there is a (possibly undefined) node at the given key

public hasDefined(key: string): boolean source

Determine whether this node has a defined child with the given name. Property node types always contain exactly one value with a key equal to the property name.