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
Summary
Actions Summary Table
Actions | Description |
---|---|
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. |
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 beginning. |
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
- Libraries.Language.Object: The object to compare to.
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
- Libraries.Language.Object: The to be compared.
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 object.
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 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.