com.sk89q.worldedit.util.command.parametric

Class BindingHelper

java.lang.Object

com.sk89q.worldedit.util.command.parametric.BindingHelper

All Implemented Interfaces:

Binding

Direct Known Subclasses:

PrimitiveBindings, StandardBindings, WorldEditBinding

public class BindingHelper
extends Object
implements Binding

A binding helper that uses the BindingMatch annotation to make writing bindings extremely easy.

Methods must have the following and only the following parameters:

• A ArgumentStack
• A Annotation if there is a classifier set
• A Annotation[] if there BindingMatch.provideModifiers() is true

Methods may throw any exception. Exceptions may be converted using a ExceptionConverter registered with the ParametricBuilder.

Constructor Summary

Constructors

Constructor and Description
BindingHelper() Create a new instance.

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

BindingHelper

public BindingHelper()

Create a new instance.

Method Detail

getTypes

public Type[] getTypes()

Description copied from interface: Binding

Get the types that this binding handles.

Specified by:

getTypes in interface Binding

Returns:

the types

getConsumedCount

public int getConsumedCount(ParameterData parameter)

Description copied from interface: Binding

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.

Specified by:

getConsumedCount in interface Binding

Parameters:

parameter - information about the parameter

Returns:

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

getBehavior

public BindingBehavior getBehavior(ParameterData parameter)

Description copied from interface: Binding

Get how this binding consumes from a ArgumentStack.

Specified by:

getBehavior in interface Binding

Parameters:

parameter - information about the parameter

Returns:

the behavior

bind

public Object bind(ParameterData parameter,
                   ArgumentStack scoped,
                   boolean onlyConsume)
            throws ParameterException,
                   CommandException,
                   InvocationTargetException

Description copied from interface: Binding

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

Specified by:

bind in interface Binding

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

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

Description copied from interface: Binding

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

Specified by:

getSuggestions in interface Binding

Parameters:

parameter - information about the parameter

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

Returns:

a list of suggestions