me.vaperion.blade.annotation.parameter

Annotation Type Opt

@Retention(value=RUNTIME)
 @Target(value=PARAMETER)
public @interface Opt

This annotation is used to indicate that a specific parameter is optional.

This used to be called Optional, but was renamed to avoid confusion with Optional.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
@NotNull java.lang.String	custom The custom value that should be used if value() is set to Opt.Type.CUSTOM.
boolean	treatErrorAsEmpty Whether a parsing error should result in a Opt.Type.EMPTY value instead of failing command execution.
@NotNull Opt.Type	value The type of default value to use when the argument is not provided.

Element Detail

value

@NotNull
public abstract @NotNull Opt.Type value

The type of default value to use when the argument is not provided.

Returns:

the type of the optional value

See Also:

Opt.Type

Default:

me.vaperion.blade.annotation.parameter.Opt.Type.EMPTY_OR_CUSTOM

custom

@NotNull
public abstract @NotNull java.lang.String custom

The custom value that should be used if value() is set to Opt.Type.CUSTOM.

Returns:

the custom value as a string

Default:

""

treatErrorAsEmpty

public abstract boolean treatErrorAsEmpty

Whether a parsing error should result in a Opt.Type.EMPTY value instead of failing command execution.

When true, unparseable arguments are treated as empty and errors are silently ignored.

Returns:

true if parsing errors should be treated as empty, false otherwise

Default:

false