revxrsal.commands.parameter.builtins

Enum OptionalParameterTypeFactory

java.lang.Object

java.lang.Enum<OptionalParameterTypeFactory>

revxrsal.commands.parameter.builtins.OptionalParameterTypeFactory

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<OptionalParameterTypeFactory>, BaseParameterType, ParameterFactory, ParameterType.Factory<CommandActor>

public enum OptionalParameterTypeFactory
extends java.lang.Enum<OptionalParameterTypeFactory>
implements ParameterType.Factory<CommandActor>

Handles parameters of type Optional and is effectively the same as using @Optional on such annotations

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
<T> @Nullable ParameterType<CommandActor,T>	create(@NotNull java.lang.reflect.Type parameterType, @NotNull AnnotationList annotations, @NotNull Lamp<CommandActor> lamp) Dynamically creates a ParameterType
static OptionalParameterTypeFactory	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static OptionalParameterTypeFactory[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface revxrsal.commands.parameter.ParameterType.Factory

forType, forTypeAndSubclasses

Enum Constant Detail

INSTANCE

public static final OptionalParameterTypeFactory INSTANCE

Method Detail

values

public static OptionalParameterTypeFactory[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (OptionalParameterTypeFactory c : OptionalParameterTypeFactory.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static OptionalParameterTypeFactory valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

create

@Nullable
public <T> @Nullable ParameterType<CommandActor,T> create(@NotNull
                                                                    @NotNull java.lang.reflect.Type parameterType,
                                                                    @NotNull
                                                                    @NotNull AnnotationList annotations,
                                                                    @NotNull
                                                                    @NotNull Lamp<CommandActor> lamp)

Description copied from interface: ParameterType.Factory

Dynamically creates a ParameterType

Specified by:

create in interface ParameterType.Factory<CommandActor>

Type Parameters:

T - The parameter type

Parameters:

parameterType - The command parameter to create for

annotations - The parameter annotations

lamp - The Lamp instance (for referencing other parameter types)

Returns:

The newly created ParameterType, or null if this factory cannot deal with it.