com.sk89q.intake.parametric

Interface Provider<T>

public interface Provider<T>

An object that provides instances given a key and some arguments.

Providers do the heavy work of reading passed in arguments and transforming them into Java objects.

Method Summary

Modifier and Type	Method and Description
T	get(CommandArgs arguments, List<? extends Annotation> modifiers) Provide a value given the arguments.
List<String>	getSuggestions(String prefix) Get a list of suggestions for the given parameter and user arguments.
boolean	isProvided() Gets whether this provider does not actually consume values from the argument stack and instead generates them otherwise.

Method Detail

isProvided

boolean isProvided()

Gets whether this provider does not actually consume values from the argument stack and instead generates them otherwise.

Returns:

Whether values are provided without use of the arguments

get

@Nullable
T get(CommandArgs arguments,
                List<? extends Annotation> modifiers)
         throws ArgumentException,
                ProvisionException

Provide a value given the arguments.

Parameters:

arguments - The arguments

modifiers - The modifiers on the parameter

Returns:

The value provided

Throws:

ArgumentException - If there is a problem with the argument

ProvisionException - If there is a problem with the provider

getSuggestions

List<String> getSuggestions(String prefix)

Get a list of suggestions for the given parameter and user arguments.

If no suggestions could be enumerated, an empty list should be returned.

Parameters:

prefix - What the user has typed so far (may be an empty string)

Returns:

A list of suggestions