Package dev.rollczi.litecommands.argument

Interface Argument<T>

All Superinterfaces:

MetaHolder, Requirement<T>

All Known Subinterfaces:

MutableArgument<T>

All Known Implementing Classes:

SimpleArgument

public interface Argument<T>
extends Requirement<T>

Method Summary

Modifier and Type	Method	Description
<NEW> Argument<NEW>	child(TypeToken<NEW> type)	Create a child of the current argument.
default Optional<ParseResult<T>>	defaultValue()	Deprecated.
Optional<ParseResult<T>>	getDefaultValue()
ArgumentKey	getKey()
String	getName()
<P> Optional<P>	getProfile(ArgumentProfileNamespace<P> key)
PrioritizedList<ArgumentProfile<?>>	getProfiles()
boolean	hasDefaultValue()
static <T> Argument<T>	of(String name, TypeToken<T> type)
static <T> Argument<T>	of(String name, TypeToken<T> type, boolean nullable)	Deprecated.
static <T> Argument<T>	of(String name, Class<T> type)
static <T> Argument<T>	of(String name, Class<T> type, boolean nullable)	Deprecated.
static <T, P extends ArgumentProfile<P>> Argument<T>	profiled(String name, TypeToken<T> type, P profile)
static <T, P extends ArgumentProfile<P>> Argument<T>	profiled(String name, Class<T> type, P profile)
Argument<T>	withoutProfile(ArgumentProfileNamespace<?> profile)

Methods inherited from interface dev.rollczi.litecommands.meta.MetaHolder

meta, metaCollector, parentMeta

Methods inherited from interface dev.rollczi.litecommands.requirement.Requirement

getType

Method Details

getName

String getName()

Specified by:

getName in interface Requirement<T>

getKey

ArgumentKey getKey()

getDefaultValue

Optional<ParseResult<T>> getDefaultValue()

defaultValue

@Deprecated
default Optional<ParseResult<T>> defaultValue()

Deprecated.

hasDefaultValue

boolean hasDefaultValue()

getProfile

@Experimental
<P> Optional<P> getProfile(ArgumentProfileNamespace<P> key)

getProfiles

@Experimental
PrioritizedList<ArgumentProfile<?>> getProfiles()

child

@Experimental
<NEW> Argument<NEW> child(TypeToken<NEW> type)

Create a child of the current argument. This is useful when resolver handles a parametrized type for class such as Optional, List, CompletableFuture, etc.

withoutProfile

@Experimental
Argument<T> withoutProfile(ArgumentProfileNamespace<?> profile)

of

static <T> Argument<T> of(String name,
 Class<T> type)

of

@Deprecated
static <T> Argument<T> of(String name,
 Class<T> type,
 boolean nullable)

Deprecated.

of

static <T> Argument<T> of(String name,
 TypeToken<T> type)

of

@Deprecated
static <T> Argument<T> of(String name,
 TypeToken<T> type,
 boolean nullable)

Deprecated.

profiled

@Experimental
static <T,
P extends ArgumentProfile<P>>
Argument<T> profiled(String name,
 Class<T> type,
 P profile)

profiled

@Experimental
static <T,
P extends ArgumentProfile<P>>
Argument<T> profiled(String name,
 TypeToken<T> type,
 P profile)