me.vaperion.blade.argument

Class InputArgument

java.lang.Object

me.vaperion.blade.argument.InputArgument

public final class InputArgument
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InputArgument.Status

Constructor Summary

Constructors

Constructor and Description
InputArgument(BladeParameter parameter)
InputArgument(@NotNull BladeParameter parameter, @Nullable java.lang.String value, InputArgument.Status status)

Method Summary

Modifier and Type	Method and Description
void	addAnnotations(@NotNull java.util.List<java.lang.annotation.Annotation> annotations)
<T extends java.lang.annotation.Annotation> T	annotation(@NotNull java.lang.Class<T> annotationClass) Gets a Forwarded from the argument.
<T extends java.lang.annotation.Annotation> @NotNull java.util.List<T>	annotationList(@NotNull java.lang.Class<T> annotationClass) Gets all Forwardeds of a specific type from the argument.
java.util.List<java.lang.String>	data()
boolean	isOptionalAcceptingNull() Checks if the argument is optional and accepts null values.
boolean	isOptionalWithType(Opt.Type type) Checks if the argument is optional with a specific type.
@Nullable Opt	optional() Gets the Opt annotation of the argument, if present.
BladeParameter	parameter()
@Nullable Range	range() Gets the Range annotation of the argument, if present.
@NotNull java.lang.String	requireValue() Gets the value of the argument, throwing an exception if it is not present.
InputArgument.Status	status()
InputArgument	status(InputArgument.Status status)
@Nullable java.lang.String	value()
InputArgument	value(@Nullable java.lang.String value)

Methods inherited from class java.lang.Object

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

Constructor Detail

InputArgument

public InputArgument(@NotNull
                     @NotNull BladeParameter parameter,
                     @Nullable
                     @Nullable java.lang.String value,
                     @NotNull
                     InputArgument.Status status)

InputArgument

public InputArgument(BladeParameter parameter)

Method Detail

requireValue

@NotNull
public @NotNull java.lang.String requireValue()

Gets the value of the argument, throwing an exception if it is not present.

Returns:

the value of the argument

Throws:

java.lang.IllegalStateException - if the value is not present

optional

@Nullable
public @Nullable Opt optional()

Gets the Opt annotation of the argument, if present.

Returns:

the Opt annotation, or null if not present

isOptionalWithType

public boolean isOptionalWithType(@NotNull
                                  Opt.Type type)

Checks if the argument is optional with a specific type.

Parameters:

type - the type to check

Returns:

true if the argument is optional with the specified type, false otherwise

isOptionalAcceptingNull

public boolean isOptionalAcceptingNull()

Checks if the argument is optional and accepts null values.

Returns:

true if the argument is optional and accepts null values, false otherwise

range

@Nullable
public @Nullable Range range()

Gets the Range annotation of the argument, if present.

Returns:

the Range annotation, or null if not present

annotation

@Nullable
public <T extends java.lang.annotation.Annotation> T annotation(@NotNull
                                                                          @NotNull java.lang.Class<T> annotationClass)

Gets a Forwarded from the argument.

Type Parameters:

T - the type of the annotation

Parameters:

annotationClass - the class of the annotation to get

Returns:

the annotation if present, otherwise null

annotationList

@NotNull
public <T extends java.lang.annotation.Annotation> @NotNull java.util.List<T> annotationList(@NotNull
                                                                                                      @NotNull java.lang.Class<T> annotationClass)

Gets all Forwardeds of a specific type from the argument.

Type Parameters:

T - the type of the annotation

Parameters:

annotationClass - the class of the annotation to get

Returns:

a list of annotations of the specified type

addAnnotations

@ApiStatus.Internal
public void addAnnotations(@NotNull
                                               @NotNull java.util.List<java.lang.annotation.Annotation> annotations)

parameter

public BladeParameter parameter()

value

@Nullable
public @Nullable java.lang.String value()

status

public InputArgument.Status status()

data

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

value

@ApiStatus.Internal
public InputArgument value(@Nullable
                                               @Nullable java.lang.String value)

Returns:

this.

status

@ApiStatus.Internal
public InputArgument status(InputArgument.Status status)

Returns:

this.