Libraries.Data.Formats.Attributes Documentation

Inheriting from the Attributes class provides a basic blueprint for a collection of Attributes.

Example Code

use Libraries.Data.Formats

class MyAttributes is Attributes
    Array<Attribute> data

    action GetName(integer index) returns text
        //implementation goes here
    end
end

Inherits from: Libraries.Language.Object

Summary

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.
GetName(integer index)This action gets the name of the Attribute at the given location in the collection of Attributes.
GetSize()This action gets the size of the collection of Attributes.
GetValue(integer index)This action gets the value of the Attribute at the given location in the collection of Attributes.

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.

GetName(integer index)

This action gets the name of the Attribute at the given location in the collection of Attributes.

Parameters

Return

text: The name of the attribute at the indexed location.

GetSize()

This action gets the size of the collection of Attributes.

Return

integer:

GetValue(integer index)

This action gets the value of the Attribute at the given location in the collection of Attributes.

Parameters

Return

text: The value of the attribute at the indexed location.