Record Class OrderingTotality.ComparatorUse

java.lang.Object

java.lang.Record

org.ek9lang.compiler.phase5.OrderingTotality.ComparatorUse

Record Components:

token - where it is used

user - what orders by it ('sort', a 'Comparator of Money')

function - the function

Enclosing class:

OrderingTotality

static record OrderingTotality.ComparatorUse(IToken token, String user, FunctionSymbol function)
extends Record

A function used as an ordering where it is not declared one.

Constructor Summary

Constructors

Constructor	Description
ComparatorUse(IToken token, String user, FunctionSymbol function)	Creates an instance of a ComparatorUse record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
FunctionSymbol	function()	Returns the value of the function record component.
final int	hashCode()	Returns a hash code value for this object.
IToken	token()	Returns the value of the token record component.
final String	toString()	Returns a string representation of this record class.
String	user()	Returns the value of the user record component.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ComparatorUse

ComparatorUse(IToken token,
 String user,
 FunctionSymbol function)

Creates an instance of a ComparatorUse record class.

Parameters:

token - the value for the token record component

user - the value for the user record component

function - the value for the function record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

token

public IToken token()

Returns the value of the token record component.

Returns:

the value of the token record component

user

public String user()

Returns the value of the user record component.

Returns:

the value of the user record component

function

public FunctionSymbol function()

Returns the value of the function record component.

Returns:

the value of the function record component