Package studio.mevera.imperat.annotations.parameters

Class AnnotationArgumentDecorator<S extends CommandSource>

java.lang.Object

studio.mevera.imperat.command.arguments.InputArgument<S>

studio.mevera.imperat.annotations.parameters.AnnotationArgumentDecorator<S>

All Implemented Interfaces:

AnnotatedArgument<S>, Argument<S>, DescriptionHolder, PermissionHolder

public final class AnnotationArgumentDecorator<S extends CommandSource>
extends InputArgument<S>
implements AnnotatedArgument<S>

Field Summary

Fields inherited from class studio.mevera.imperat.command.arguments.InputArgument

defaultValueProvider, description, flag, format, greedy, index, name, optional, parentCommand, permissionsData, suggestionProvider, type

Method Summary

Modifier and Type	Method	Description
FlagArgument<S>	asFlagParameter()	Casts the parameter to a flag parameter
NumericArgument<S>	asNumeric()
static <S extends CommandSource> AnnotationArgumentDecorator<S>	decorate(Argument<S> parameter, ParameterElement element)
String	format()	Formats the usage parameter*
<A extends Annotation> A	getAnnotation(Class<A> clazz)	Get the instance of specific annotation
@Unmodifiable Collection<? extends Annotation>	getAnnotations()
@NotNull ParseElement<?>	getParsedElement()
boolean	isFlag()

Methods inherited from class studio.mevera.imperat.command.arguments.InputArgument

addValidator, asCommand, describe, equals, getDefaultValueSupplier, getDescription, getName, getParent, getPermissionsData, getPosition, getSuggestionResolver, getValidators, hashCode, isGreedy, isGreedyString, isOptional, setFormat, setParent, setPermissionData, setPosition, similarTo, toString, type, validate, wrappedType

Methods inherited from class java.lang.Object

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

Methods inherited from interface studio.mevera.imperat.annotations.parameters.AnnotatedArgument

hasAnnotation

Methods inherited from interface studio.mevera.imperat.command.arguments.Argument

addValidator, asAnnotatedArgument, asCommand, getDefaultValueSupplier, getName, getParent, getPosition, getSuggestionResolver, getValidators, greedyLimit, isAnnotated, isCommand, isGreedy, isGreedyString, isNumeric, isOptional, isRequired, setFormat, setParent, setPosition, similarTo, type, validate, valueType, wrappedType

Methods inherited from interface studio.mevera.imperat.command.DescriptionHolder

describe, describe, getDescription

Methods inherited from interface studio.mevera.imperat.permissions.PermissionHolder

getPermissionsData, getPrimaryPermission, setPermissionData

Method Details

decorate

public static <S extends CommandSource>
AnnotationArgumentDecorator<S> decorate(Argument<S> parameter,
 ParameterElement element)

getParsedElement

@NotNull
public @NotNull ParseElement<?> getParsedElement()

Specified by:

getParsedElement in interface AnnotatedArgument<S extends CommandSource>

getAnnotation

@Nullable
public <A extends Annotation> A getAnnotation(Class<A> clazz)

Get the instance of specific annotation

Specified by:

getAnnotation in interface AnnotatedArgument<S extends CommandSource>

Type Parameters:

A - the valueType of the annotation

Parameters:

clazz - the valueType of annotation

Returns:

the specific instance of an annotation of a certain valueType AnnotationArgumentDecorator

getAnnotations

public @Unmodifiable Collection<? extends Annotation> getAnnotations()

Specified by:

getAnnotations in interface AnnotatedArgument<S extends CommandSource>

Returns:

the annotations associated with this parameter

format

public String format()

Formats the usage parameter*

Specified by:

format in interface Argument<S extends CommandSource>

Overrides:

format in class InputArgument<S extends CommandSource>

Returns:

the formatted parameter

See Also:

• Argument.getName()

asFlagParameter

public FlagArgument<S> asFlagParameter()

Casts the parameter to a flag parameter

Specified by:

asFlagParameter in interface Argument<S extends CommandSource>

Overrides:

asFlagParameter in class InputArgument<S extends CommandSource>

Returns:

the parameter as a flag

isFlag

public boolean isFlag()

Specified by:

isFlag in interface Argument<S extends CommandSource>

Overrides:

isFlag in class InputArgument<S extends CommandSource>

Returns:

checks whether this parameter is a flag

asNumeric

public NumericArgument<S> asNumeric()

Specified by:

asNumeric in interface Argument<S extends CommandSource>