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

Summary

Variable Summary Table

VariablesDescription
Libraries.Language.Object value
Libraries.Language.Object key
Libraries.Containers.Support.KeyedNode next

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns a CompareResult.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetHashCode()This action gets the hash code for an object.
GetKey()This action gets the key stored in the keyed node.
GetNext()This action gets the next node.
GetValue()This action gets the value stored in the keyed node.
Set(Key key)This action sets the key in the keyed node.
Set(Key key, Value value)This action sets the key-value pair in the keyed node.

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns a CompareResult. The compare result is either larger if this hash code is larger than the object passed as a parameter, smaller, or equal.

Example Code

use Libraries.Language.Support.CompareResult
        Object o
        Object t
        CompareResult result = o:Compare(t)

Parameters

Return

Libraries.Language.Support.CompareResult: The Compare result, Smaller, Equal, or Larger.

Equals(Libraries.Language.Object object)

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

Example Code

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

Parameters

Return

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

GetHashCode()

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode()

Return

integer: The integer hash code of the object.

GetKey()

This action gets the key stored in the keyed node.

Example Code

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

Return

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

GetNext()

This action gets the next node.

Example Code

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

Return

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

GetValue()

This action gets the value stored in the keyed node.

Example Code

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

Return

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

Set(Key key)

This action sets the key in the keyed node.

Example Code

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

Parameters

Set(Key key, Value value)

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

Example Code

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

Parameters