com.sk89q.intake.parametric.binding

Interface Binding

All Known Implementing Classes:

BindingHelper, PrimitiveBindings, StandardBindings

public interface Binding

A binding injects instances of the parameters of methods (that are commands) that were converted into commands using an instance of ParametricBuilder.

A binding can be used to handle several types at once. For a binding to be called, it must be registered with a ParametricBuilder with ParametricBuilder.addBinding(Binding, Type...).

See Also:

an example of primitive bindings, standard bindings

Method Summary

Modifier and Type	Method and Description
Object	bind(ParameterData<?> parameter, ArgumentStack scoped, boolean onlyConsume) Attempt to consume values (if required) from the given ArgumentStack in order to instantiate an object for the given parameter.
BindingBehavior	getBehavior(ParameterData<?> parameter) Get how this binding consumes from a ArgumentStack.
int	getConsumedCount(ParameterData<?> parameter) Get the number of arguments that this binding will consume, if this information is available.
List<String>	getSuggestions(ParameterData<?> parameter, String prefix) Get a list of suggestions for the given parameter and user arguments.
Type[]	getTypes() Get the types that this binding handles.

Method Detail

getTypes

Type[] getTypes()

Get the types that this binding handles.

Returns:

the types

getBehavior

BindingBehavior getBehavior(ParameterData<?> parameter)

Get how this binding consumes from a ArgumentStack.

Parameters:

parameter - information about the parameter

Returns:

the behavior

getConsumedCount

int getConsumedCount(ParameterData<?> parameter)

Get the number of arguments that this binding will consume, if this information is available.

This method must return -1 for binding behavior types that are not BindingBehavior.CONSUMES.

Parameters:

parameter - information about the parameter

Returns:

the number of consumed arguments, or -1 if unknown or irrelevant

bind

Object bind(ParameterData<?> parameter,
            ArgumentStack scoped,
            boolean onlyConsume)
     throws ParameterException,
            CommandException,
            InvocationTargetException

Attempt to consume values (if required) from the given ArgumentStack in order to instantiate an object for the given parameter.

Parameters:

parameter - information about the parameter

scoped - the arguments the user has input

onlyConsume - true to only consume arguments

Returns:

an object parsed for the given parameter

Throws:

ParameterException - thrown if the parameter could not be formulated

CommandException - on a command exception

InvocationTargetException

getSuggestions

List<String> getSuggestions(ParameterData<?> parameter,
                            String prefix)

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

Parameters:

parameter - information about the parameter

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

Returns:

a list of suggestions