Package kboyle.oktane.core.results.tokeniser

Record Class TokeniserSuccessfulResult

java.lang.Object

java.lang.Record

kboyle.oktane.core.results.tokeniser.TokeniserSuccessfulResult

All Implemented Interfaces:

Result, SuccessfulResult, TokeniserResult

public record TokeniserSuccessfulResult(List<String> tokens)
extends Record
implements TokeniserResult, SuccessfulResult

Constructor Summary

Constructors

Constructor	Description
TokeniserSuccessfulResult(List<String> tokens)	Creates an instance of a TokeniserSuccessfulResult record class.

Method Summary

Modifier and Type	Method	Description
static TokeniserSuccessfulResult	empty()
boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	hashCode()	Returns a hash code value for this object.
List<String>	tokens()	Returns the value of the tokens record component.
String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Methods inherited from interface kboyle.oktane.core.results.SuccessfulResult

success

Methods inherited from interface kboyle.oktane.core.results.tokeniser.TokeniserResult

mono

Constructor Details

TokeniserSuccessfulResult

public TokeniserSuccessfulResult(List<String> tokens)

Creates an instance of a TokeniserSuccessfulResult record class.

Parameters:

tokens - the value for the tokens record component

Method Details

empty

public static TokeniserSuccessfulResult empty()

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.

tokens

public List<String> tokens()

Returns the value of the tokens record component.

Specified by:

tokens in interface TokeniserResult

Returns:

the value of the tokens record component