me.vaperion.blade.command

Class BladeParameter

java.lang.Object

me.vaperion.blade.command.BladeParameter

Direct Known Subclasses:

DefinedArgument, DefinedFlag

public class BladeParameter
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	alwaysQuoted
protected java.util.List<java.lang.String>	data
protected @Nullable java.lang.reflect.AnnotatedElement	element
protected java.lang.String	name
protected java.lang.Class<?>	type

Constructor Summary

Constructors

Constructor and Description
BladeParameter(Blade blade, java.lang.String name, java.lang.Class<?> type, java.util.List<java.lang.String> data, @Nullable java.lang.reflect.AnnotatedElement element)

Method Summary

Modifier and Type	Method and Description
@NotNull java.util.List<java.lang.annotation.Annotation>	annotations() Returns all annotations present on this parameter.
Blade	blade()
@Nullable ArgumentProvider<?>	customCompleter() Returns the custom ArgumentProvider used for tab-completing this parameter, if any.
@Nullable ArgumentProvider<?>	customParser() Returns the custom ArgumentProvider used for parsing this parameter, if any.
java.util.List<java.lang.String>	data()
@Nullable java.lang.reflect.AnnotatedElement	element()
boolean	hasCustomCompleter() Returns whether this parameter has a custom completer.
boolean	hasCustomParser() Returns whether this parameter has a custom parser.
boolean	hasRange() Returns whether this parameter has a range annotation.
boolean	isGreedy() Returns whether this parameter has a greedy annotation.
boolean	isOptional() Returns whether this parameter has an optional annotation.
boolean	isQuoted() Returns whether this parameter has a quoted annotation.
java.lang.String	name()
@Nullable Opt	optional() Returns the Opt annotation of this parameter, if present.
@Nullable Provider	provider() Returns the Provider annotation of this parameter, if present.
@Nullable Range	range() Returns the Range annotation of this parameter, if present.
java.lang.Class<?>	type()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

protected final java.lang.String name

type

protected final java.lang.Class<?> type

data

protected final java.util.List<java.lang.String> data

element

@Nullable
protected final @Nullable java.lang.reflect.AnnotatedElement element

alwaysQuoted

protected boolean alwaysQuoted

Constructor Detail

BladeParameter

public BladeParameter(Blade blade,
                      java.lang.String name,
                      java.lang.Class<?> type,
                      java.util.List<java.lang.String> data,
                      @Nullable
                      @Nullable java.lang.reflect.AnnotatedElement element)

Method Detail

annotations

@NotNull
public @NotNull java.util.List<java.lang.annotation.Annotation> annotations()

Returns all annotations present on this parameter.

Returns:

a list of annotations

optional

@Nullable
public @Nullable Opt optional()

Returns the Opt annotation of this parameter, if present.

Returns:

the optional annotation, or null if not present

isOptional

public boolean isOptional()

Returns whether this parameter has an optional annotation.

Returns:

true if the parameter has an optional annotation

range

@Nullable
public @Nullable Range range()

Returns the Range annotation of this parameter, if present.

Returns:

the range annotation, or null if not present

hasRange

public boolean hasRange()

Returns whether this parameter has a range annotation.

Returns:

true if the parameter has a range annotation

isQuoted

public boolean isQuoted()

Returns whether this parameter has a quoted annotation.

Returns:

true if the parameter has a quoted annotation

provider

@Nullable
public @Nullable Provider provider()

Returns the Provider annotation of this parameter, if present.

Returns:

the provider annotation, or null if not present

hasCustomParser

public boolean hasCustomParser()

Returns whether this parameter has a custom parser.

Returns:

true if the parameter has a custom parser

customParser

@Nullable
public @Nullable ArgumentProvider<?> customParser()

Returns the custom ArgumentProvider used for parsing this parameter, if any.

Returns:

the custom argument provider, or null if not present

hasCustomCompleter

public boolean hasCustomCompleter()

Returns whether this parameter has a custom completer.

Returns:

true if the parameter has a custom completer

customCompleter

@Nullable
public @Nullable ArgumentProvider<?> customCompleter()

Returns the custom ArgumentProvider used for tab-completing this parameter, if any.

Returns:

the custom argument provider, or null if not present

isGreedy

public boolean isGreedy()

Returns whether this parameter has a greedy annotation.

Returns:

true if the parameter has a greedy annotation

blade

public Blade blade()

name

public java.lang.String name()

type

public java.lang.Class<?> type()

data

public java.util.List<java.lang.String> data()

element

@Nullable
public @Nullable java.lang.reflect.AnnotatedElement element()