Libraries.Containers.Support.Pair Documentation

This class represents a set of two types. It is a convenience class for applications that need a pair.

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
AreValuesEqual()This action asks if the two items have an equal value.
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.
GetFirstValue()This action gets the first value in the pair
GetGreatestValue()This action gets the larger value in the pair
GetHashCode()This action gets the hash code for an object.
GetLeastValue()This action gets the smaller value in the pair
GetSecondValue()This action gets the second value in the pair
Set(Type first, Type second)This action sets the pair.

Actions Documentation

AreValuesEqual()

This action asks if the two items have an equal value.

Return

boolean: True if the items are equal.

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

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

Parameters

Return

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

GetFirstValue()

This action gets the first value in the pair

Return

Libraries.Language.Object: The first value in the pair.

GetGreatestValue()

This action gets the larger value in the pair

Return

Libraries.Language.Object: The larger value in the pair.

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.

GetLeastValue()

This action gets the smaller value in the pair

Return

Libraries.Language.Object: The smaller value in the pair.

GetSecondValue()

This action gets the second value in the pair

Return

Libraries.Language.Object: The first value in the pair.

Set(Type first, Type second)

This action sets the pair.

Parameters