Package kboyle.oktane.core.results.argumentparser

Record Class ArgumentParserFailedResult

java.lang.Object

java.lang.Record

kboyle.oktane.core.results.argumentparser.ArgumentParserFailedResult

All Implemented Interfaces:

ArgumentParserResult, FailedResult, Result

public record ArgumentParserFailedResult(CommandParameter parameter, String token, TypeParserResult<?> result)
extends Record
implements FailedResult, ArgumentParserResult

Constructor Summary

Constructors

Constructor	Description
ArgumentParserFailedResult(CommandParameter parameter, String token, TypeParserResult<?> result)	Creates an instance of a ArgumentParserFailedResult record class.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	hashCode()	Returns a hash code value for this object.
CommandParameter	parameter()	Returns the value of the parameter record component.
Object[]	parsedArguments()
String	reason()
TypeParserResult<?>	result()	Returns the value of the result record component.
String	token()	Returns the value of the token 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.argumentparser.ArgumentParserResult

mono

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

success

Constructor Details

ArgumentParserFailedResult

public ArgumentParserFailedResult(CommandParameter parameter,
 String token,
 TypeParserResult<?> result)

Creates an instance of a ArgumentParserFailedResult record class.

Parameters:

parameter - the value for the parameter record component

token - the value for the token record component

result - the value for the result record component

Method Details

reason

public String reason()

Specified by:

reason in interface FailedResult

parsedArguments

public Object[] parsedArguments()

Specified by:

parsedArguments in interface ArgumentParserResult

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.

parameter

public CommandParameter parameter()

Returns the value of the parameter record component.

Returns:

the value of the parameter record component

token

public String token()

Returns the value of the token record component.

Returns:

the value of the token record component

result

public TypeParserResult<?> result()

Returns the value of the result record component.

Returns:

the value of the result record component