com.sk89q.worldedit.util.command.fluent

Class DispatcherNode

java.lang.Object

com.sk89q.worldedit.util.command.fluent.DispatcherNode

public class DispatcherNode
extends Object

A collection of commands.

Method Summary

Modifier and Type	Method and Description
DispatcherNode	describeAs(String description) Set the description.
Dispatcher	getDispatcher() Get the underlying dispatcher of this object.
CommandGraph	graph() Get the root command graph.
DispatcherNode	group(String... alias) Create a new command that will contain sub-commands.
DispatcherNode	parent() Return the parent node.
void	register(CommandCallable callable, String... alias) Register a command with this dispatcher.
DispatcherNode	registerMethods(Object object) Build and register a command with this dispatcher using the ParametricBuilder assigned on the root CommandGraph.

Methods inherited from class java.lang.Object

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

Method Detail

describeAs

public DispatcherNode describeAs(String description)

Set the description.

This can only be used on DispatcherNodes returned by group(String...).

Parameters:

description - the description

Returns:

this object

register

public void register(CommandCallable callable,
                     String... alias)

Register a command with this dispatcher.

Parameters:

callable - the executor

alias - the list of aliases, where the first alias is the primary one

registerMethods

public DispatcherNode registerMethods(Object object)

Build and register a command with this dispatcher using the ParametricBuilder assigned on the root CommandGraph.

Parameters:

object - the object provided to the ParametricBuilder

Returns:

this object

See Also:

ParametricBuilder.registerMethodsAsCommands(com.sk89q.worldedit.util.command.Dispatcher, Object)

group

public DispatcherNode group(String... alias)

Create a new command that will contain sub-commands.

The object returned by this method can be used to add sub-commands. To return to this "parent" context, use graph().

Parameters:

alias - the list of aliases, where the first alias is the primary one

Returns:

an object to place sub-commands

parent

public DispatcherNode parent()

Return the parent node.

Returns:

the parent node

Throws:

RuntimeException - if there is no parent node.

graph

public CommandGraph graph()

Get the root command graph.

Returns:

the root command graph

getDispatcher

public Dispatcher getDispatcher()

Get the underlying dispatcher of this object.

Returns:

the dispatcher