Libraries.Language.Support.CompareResult Documentation

The CompareResult class provides constants to represent results of a comparison. The possible results include LARGER, EQUAL, SMALLER, and INVALID. Each corresponds to an integer value, 1, 0, -1, and -2, respectively.

Example Code

use Libraries.Language.Support.CompareResult

class Main
action Main
   Number one
   one:SetValue(10.3)
   Number two
   two:SetValue(9.6)

   if one:Compare(two) = CompareResult:LARGER
     output "one is larger than two"
   end
end
end

Inherits from: Libraries.Language.Object

Variables Table

VariablesDescription
integer INVALID
integer result
integer EQUAL
integer LARGER
integer SMALLER

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)

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