Libraries.Containers.Iterator Documentation

Inheriting from the Iterator class provides a basic blueprint for iterating over an item.

Example Code



use Libraries.Containers.Iterator

class MyClass<Type> is Iterator<Type>
action HasNext returns boolean
    //implement here
end
end

Inherits from: Libraries.Language.Object

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)

GetCurrent()

This action gets the current item and does not move onto the next item to be iterated over.

Return

Libraries.Language.Object: Returns the object.

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()

HasNext()

This action determines if there is a next item in the iteration.

Return

boolean: true if there is a next item and false if there is not.

Next()

This action gets the next item in the iteration and continues the iteration.

Return

Libraries.Language.Object: Returns the object.

Rewind()

This action starts the iteration over from the beginning.