revxrsal.commands.parameter

Class ParameterTypes<A extends CommandActor>

java.lang.Object

revxrsal.commands.parameter.ParameterTypes<A>

Type Parameters:

A - The actor type

public final class ParameterTypes<A extends CommandActor>
extends java.lang.Object

An immutable registry of ParameterTypes and ParameterType.Factories.

This type should be constructed using builder().

See Also:

ParameterType, ContextParameter, ParseWith

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ParameterTypes.Builder<A extends CommandActor>

Method Summary

Modifier and Type	Method and Description
static <A extends CommandActor> @NotNull ParameterTypes.Builder<A>	builder() Creates a new ParameterTypes.Builder for ParameterTypes.
<T> ParameterResolver<A,T>	findNextResolver(java.lang.reflect.Type type, AnnotationList annotations, ParameterFactory skipPast, Lamp<A> lamp) Returns the first ParameterType that comes after the skipPast factory.
<T> @NotNull ParameterResolver<A,T>	resolver(java.lang.reflect.Type type, AnnotationList annotations, Lamp<A> lamp) Returns the first ParameterType that can parse the given type and annotations.
@NotNull ParameterTypes.Builder<A>	toBuilder() Creates a ParameterTypes.Builder that contains the factories registered in this registry.

Methods inherited from class java.lang.Object

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

Method Detail

builder

@Contract(value="-> new",
          pure=true)
 @NotNull
public static <A extends CommandActor> @NotNull ParameterTypes.Builder<A> builder()

Creates a new ParameterTypes.Builder for ParameterTypes.

Type Parameters:

A - The actor type

Returns:

The newly created ParameterTypes.Builder.

resolver

@NotNull
public <T> @NotNull ParameterResolver<A,T> resolver(java.lang.reflect.Type type,
                                                             AnnotationList annotations,
                                                             Lamp<A> lamp)

Returns the first ParameterType that can parse the given type and annotations. This method can be used to create more complex parameter types for composite types (such as T[])

Note that this method will never return null. In cases where no suitable factory is found, it will throw IllegalArgumentException.

Parameters:

type - The type to create for

annotations - The annotations to pass to factories

lamp - The Lamp instance to pass to factories

Returns:

The parameter type

Throws:

java.lang.IllegalStateException - if no suitable parameter type was found

findNextResolver

public <T> ParameterResolver<A,T> findNextResolver(java.lang.reflect.Type type,
                                                   AnnotationList annotations,
                                                   ParameterFactory skipPast,
                                                   Lamp<A> lamp)

Returns the first ParameterType that comes after the skipPast factory. This is useful for adding behavior on top of existing factory.

Parameters:

type - The type to create for

annotations - The annotations to pass to factories

skipPast - The factory to skip past. In most cases, this will be the caller factory, i.e. this.

lamp - The Lamp instance to pass to factories

Returns:

The parameter type

Throws:

java.lang.IllegalStateException - if no suitable parameter type was found

toBuilder

@Contract(value="-> new",
          pure=true)
 @NotNull
public @NotNull ParameterTypes.Builder<A> toBuilder()

Creates a ParameterTypes.Builder that contains the factories registered in this registry.

Returns:

The new builder