Package studio.mevera.imperat.annotations.parameters

Class AnnotationParameterDecorator<S extends Source>

java.lang.Object

studio.mevera.imperat.command.parameters.InputParameter<S>

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

All Implemented Interfaces:

AnnotatedParameter<S>, DescriptionHolder, CommandParameter<S>, PermissionHolder

public final class AnnotationParameterDecorator<S extends Source>
extends InputParameter<S>
implements AnnotatedParameter<S>

Field Summary

Fields inherited from class studio.mevera.imperat.command.parameters.InputParameter

description, flag, format, greedy, index, name, optional, optionalValueSupplier, parentCommand, permission, suggestionResolver, type

Method Summary

Modifier and Type	Method	Description
FlagParameter<S>	asFlagParameter()	Casts the parameter to a flag parameter
CommandParameter<S>	copyWithDifferentPosition(int newPosition)	Creates a copy of this parameter with a different position.
static <S extends Source> AnnotationParameterDecorator<S>	decorate(CommandParameter<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()
boolean	isFlag()

Methods inherited from class studio.mevera.imperat.command.parameters.InputParameter

addPermission, asCommand, describe, description, equals, getDefaultValueSupplier, getPermissions, getSinglePermission, getSuggestionResolver, hashCode, isGreedy, isGreedyString, isOptional, name, parent, parent, position, position, setFormat, setSinglePermission, similarTo, toString, type, 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.AnnotatedParameter

hasAnnotation

Methods inherited from interface studio.mevera.imperat.command.parameters.CommandParameter

asAnnotated, asCommand, asNumeric, getDefaultValueSupplier, getSinglePermission, getSuggestionResolver, isAnnotated, isCommand, isGreedy, isGreedyString, isNumeric, isOptional, isRequired, name, parent, parent, position, position, setFormat, setSinglePermission, similarTo, type, valueType, wrappedType

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

describe, describe, description

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

addPermission, getPermissions, hasPermission

Method Details

decorate

public static <S extends Source>
AnnotationParameterDecorator<S> decorate(CommandParameter<S> parameter,
 ParameterElement element)

getAnnotation

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

Get the instance of specific annotation

Specified by:

getAnnotation in interface AnnotatedParameter<S extends Source>

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 AnnotationParameterDecorator

getAnnotations

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

Specified by:

getAnnotations in interface AnnotatedParameter<S extends Source>

Returns:

the annotations associated with this parameter

format

public String format()

Formats the usage parameter*

Specified by:

format in interface CommandParameter<S extends Source>

Overrides:

format in class InputParameter<S extends Source>

Returns:

the formatted parameter

See Also:

• CommandParameter.name()

asFlagParameter

public FlagParameter<S> asFlagParameter()

Casts the parameter to a flag parameter

Specified by:

asFlagParameter in interface CommandParameter<S extends Source>

Overrides:

asFlagParameter in class InputParameter<S extends Source>

Returns:

the parameter as a flag

isFlag

public boolean isFlag()

Specified by:

isFlag in interface CommandParameter<S extends Source>

Overrides:

isFlag in class InputParameter<S extends Source>

Returns:

checks whether this parameter is a flag

copyWithDifferentPosition

public CommandParameter<S> copyWithDifferentPosition(int newPosition)

Creates a copy of this parameter with a different position. Useful for commands that have multiple syntaxes.

Specified by:

copyWithDifferentPosition in interface CommandParameter<S extends Source>

Parameters:

newPosition - the new position to set

Returns:

a copy of this parameter with the new position