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
e

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetCurrent()This action gets the current item and does not move onto the next item to be iterated over.
GetHashCode()This action gets the hash code for an object.
HasNext()This action determines if there is a next item in the iteration.
Next()This action gets the next item in the iteration and continues the iteration.
Rewind()This action starts the iteration over from the beginnin

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.

Example Code

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

Parameters

Return

integer: 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(

Parameters

Return

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

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 objec

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.

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 no

Next()

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

Return

Libraries.Language.Object: Returns the objec

Rewind()

This action starts the iteration over from the beginnin