Libraries.Containers.Support.KeyedNode Documentation

The KeyedNode class is a support class for keyed data structures such as the Tree.

Example Code

use Libraries.Containers.Support.KeyedNode

class Main
action main
    KeyedNode<text, integer> node
    node:Set("Melissa", 29)
end
end

Inherits from: Libraries.Language.Object

Variables Table

VariablesDescription
Libraries.Language.Object key
Libraries.Containers.Support.KeyedNode nextThis action gets the next node.
Libraries.Language.Object value

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Example

Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

Example

use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

GetKey()

This action gets the key stored in the keyed node.

Return

Libraries.Language.Object: The key stored in the keyed node.

Example

use Libraries.Containers.Support.KeyedNode
KeyedNode<text, integer> node
text k = node:GetKey()

GetNext()

This action gets the next node.

Return

Libraries.Containers.Support.KeyedNode: The next node of type KeyedNode

Example

use Libraries.Containers.Support.KeyedNode
KeyedNode<text, integer> node
node:GetNext()

GetValue()

This action gets the value stored in the keyed node.

Return

Libraries.Language.Object: The value stored in the keyed node.

Example

use Libraries.Containers.Support.KeyedNode
KeyedNode<text, integer> node
integer val = node:GetValue()

Set(Key key)

This action sets the key in the keyed node.

Parameters

Example

use Libraries.Containers.Support.KeyedNode
KeyedNode<text, integer> node
node:Set("Melissa")

Set(Key key, Value value)

This action sets the key-value pair in the keyed node.

Parameters

Example

use Libraries.Containers.Support.KeyedNode
KeyedNode<text, integer> node
node:Set("Melissa", 29)