Record Class StringArgumentType<T>

java.lang.Object

java.lang.Record

de.kentoj.kencommandapi.api.argument.types.StringArgumentType<T>

All Implemented Interfaces:

ArgumentType<T,String>

public record StringArgumentType<T>(boolean greedy)
extends Record
implements ArgumentType<T,String>

Constructor Summary

Constructors

Constructor	Description
StringArgumentType()
StringArgumentType(boolean greedy)	Creates an instance of a StringArgumentType record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
SuggestionProvider<T>	getDefaultSuggestionProvider()
boolean	greedy()	Returns the value of the greedy record component.
final int	hashCode()	Returns a hash code value for this object.
String	parseInputUnchecked(String string)	parses the given input and returns it.
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

StringArgumentType

public StringArgumentType()

StringArgumentType

public StringArgumentType(boolean greedy)

Creates an instance of a StringArgumentType record class.

Parameters:

greedy - the value for the greedy record component

Method Details

parseInputUnchecked

public String parseInputUnchecked(String string)

Description copied from interface: ArgumentType

parses the given input and returns it. Unlike CommandArgumentSpec.parseInput(String), this does not check any additional requirements.

Specified by:

parseInputUnchecked in interface ArgumentType<T,String>

See Also:

• CommandArgumentSpec.parseInput(String)
• CommandArgumentSpecBuilder.withRequirement(Predicate, String)

getDefaultSuggestionProvider

public SuggestionProvider<T> getDefaultSuggestionProvider()

Specified by:

getDefaultSuggestionProvider in interface ArgumentType<T,String>

See Also:

• CommandArgumentSpec.suggestionProvider()

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 the compare method from their corresponding wrapper classes.

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.

greedy

public boolean greedy()

Returns the value of the greedy record component.

Specified by:

greedy in interface ArgumentType<T,String>

Returns:

the value of the greedy record component