Record Class WalkResult.Complete<C extends CommandContext<C>>

java.lang.Object

java.lang.Record

site.lab0x13.scrow.commands.parser.WalkResult.Complete<C>

All Implemented Interfaces:

WalkResult<C>

Enclosing interface:

WalkResult<C extends CommandContext<C>>

public static record WalkResult.Complete<C extends CommandContext<C>>(C extends CommandContext<C> ctx, Literal<C extends CommandContext<C>> lastLiteral, List<? extends LiteralMeta> alternativeLiterals)
extends Record
implements WalkResult<C>

Nested Class Summary

Nested classes/interfaces inherited from interface WalkResult

WalkResult.ArgumentExpected<C>, WalkResult.ArgumentIllegal<C>, WalkResult.Complete<C>, WalkResult.LiteralExpected<C>, WalkResult.LiteralUnknown<C>

Constructor Summary

Constructors

Constructor	Description
Complete(C ctx, Literal<C> lastLiteral, List<? extends LiteralMeta> alternativeLiterals)	Creates an instance of a Complete record class.

Method Summary

Modifier and Type	Method	Description
List<? extends LiteralMeta>	alternativeLiterals()	Returns the value of the alternativeLiterals record component.
C	ctx()	Returns the value of the ctx record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
boolean	isValidUsage()
Literal<C>	lastLiteral()	Returns the value of the lastLiteral record component.
@Nullable String	message()
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

Complete

public Complete(C ctx,
 Literal<C> lastLiteral,
 List<? extends LiteralMeta> alternativeLiterals)

Creates an instance of a Complete record class.

Parameters:

ctx - the value for the ctx record component

lastLiteral - the value for the lastLiteral record component

alternativeLiterals - the value for the alternativeLiterals record component

Method Details

isValidUsage

public boolean isValidUsage()

Specified by:

isValidUsage in interface WalkResult<C extends CommandContext<C>>

message

@Nullable
public @Nullable String message()

Specified by:

message in interface WalkResult<C extends CommandContext<C>>

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.

ctx

public C ctx()

Returns the value of the ctx record component.

Specified by:

ctx in interface WalkResult<C extends CommandContext<C>>

Returns:

the value of the ctx record component

lastLiteral

public Literal<C> lastLiteral()

Returns the value of the lastLiteral record component.

Specified by:

lastLiteral in interface WalkResult<C extends CommandContext<C>>

Returns:

the value of the lastLiteral record component

alternativeLiterals

public List<? extends LiteralMeta> alternativeLiterals()

Returns the value of the alternativeLiterals record component.

Returns:

the value of the alternativeLiterals record component