Skip to content

Value


abstract class Value

Value.

Member Functions

Name Description
accept Accept a generator.
find Find an entry in an object.
insert Insert an entry in an object.
insert Insert an element at the end of an array.
size Get the size of the array.
walk Iterate through elements of an array.
pushNil Push a nil element onto the end of an array.
push Push an element onto the end of an array.
push Push an element onto the end of an array.
push Push an element onto the end of an array.
push Push an element onto the end of an array.
push Push an element onto the end of an array.
push Push an element onto the end of an array.
push Push an element onto the end of an array.
push Push an element onto the end of an array.
getBoolean Get this as a Boolean.
getInteger Get this as an integer.
getReal Get this as a real.
getString Get this as a string.
getBooleanVector Get this as a vector of Booleans.
getIntegerVector Get this as a vector of integers.
getRealVector Get this as a vector of reals.
getBooleanMatrix Get this as a matrix of Booleans.
getIntegerMatrix Get this as a matrix of integers.
getRealMatrix Get this as a matrix of reals.

Member Function Details

accept

abstract function accept(writer:Writer)

Accept a generator.

find

function find(key:String) -> Buffer?

Find an entry in an object.

getBoolean

function getBoolean() -> Boolean?

Get this as a Boolean.

Return: An optional with a value if this is of a compatible type.

getBooleanMatrix

function getBooleanMatrix() -> Boolean[_,_]?

Get this as a matrix of Booleans.

Return: An optional with a value if this is an array where all elements are themselves arrays of the same length and compatible type.

getBooleanVector

function getBooleanVector() -> Boolean[_]?

Get this as a vector of Booleans.

Return: An optional with a value if this is an array with all elements of a compatible type.

getInteger

function getInteger() -> Integer?

Get this as an integer.

Return: An optional with a value if this is of a compatible type.

getIntegerMatrix

function getIntegerMatrix() -> Integer[_,_]?

Get this as a matrix of integers.

Return: An optional with a value if this is an array where all elements are themselves arrays of the same length and compatible type.

getIntegerVector

function getIntegerVector() -> Integer[_]?

Get this as a vector of integers.

Return: An optional with a value if this is an array with all elements of a compatible type.

getReal

function getReal() -> Real?

Get this as a real.

Return: An optional with a value if this is of a compatible type.

getRealMatrix

function getRealMatrix() -> Real[_,_]?

Get this as a matrix of reals.

Return: An optional with a value if this is an array where all elements are themselves arrays of the same length and compatible type.

getRealVector

function getRealVector() -> Real[_]?

Get this as a vector of reals.

Return: An optional with a value if this is an array with all elements of a compatible type.

getString

function getString() -> String?

Get this as a string.

Return: An optional with a value if this is of a compatible type.

insert

function insert(key:String, value:Buffer)

Insert an entry in an object.

function insert(value:Buffer)

Insert an element at the end of an array.

push

abstract function push(value:Boolean) -> Value

Push an element onto the end of an array.

  • value: The element.

Returns: A new Value to replace this if a type conversion was necessary to perform the update, otherwise this.

abstract function push(value:Integer) -> Value

Push an element onto the end of an array.

  • value: The element.

Returns: A new Value to replace this if a type conversion was necessary to perform the update, otherwise this.

abstract function push(value:Real) -> Value

Push an element onto the end of an array.

  • value: The element.

Returns: A new Value to replace this if a type conversion was necessary to perform the update, otherwise this.

abstract function push(value:String) -> Value

Push an element onto the end of an array.

  • value: The element.

Returns: A new Value to replace this if a type conversion was necessary to perform the update, otherwise this.

abstract function push(value:Object) -> Value

Push an element onto the end of an array.

  • value: The element.

Returns: A new Value to replace this if a type conversion was necessary to perform the update, otherwise this.

abstract function push(value:Boolean[_]) -> Value

Push an element onto the end of an array.

  • value: The element.

Returns: A new Value to replace this if a type conversion was necessary to perform the update, otherwise this.

abstract function push(value:Integer[_]) -> Value

Push an element onto the end of an array.

  • value: The element.

Returns: A new Value to replace this if a type conversion was necessary to perform the update, otherwise this.

abstract function push(value:Real[_]) -> Value

Push an element onto the end of an array.

  • value: The element.

Returns: A new Value to replace this if a type conversion was necessary to perform the update, otherwise this.

pushNil

abstract function pushNil() -> Value

Push a nil element onto the end of an array.

Returns: A new Value to replace this if a type conversion was necessary to perform the update, otherwise this.

size

function size() -> Integer

Get the size of the array. Returns 1 for a non-array value.

walk

function walk() -> Iterator<Buffer>

Iterate through elements of an array.