Package net.orbyfied.j8.command

Class Node

java.lang.Object

net.orbyfied.j8.command.Node

public class Node
extends Object

Represents a command node in the command tree. Has components that determine what it is and can do.

Field Summary

Fields

Modifier and Type	Field	Description
protected final List<String>	aliases	The aliases of this node.
protected final ArrayList<Node>	children	The children (subnodes/subcommands) of this node.
protected final HashMap<String,Node>	childrenByName	The children (subnodes/subcommands) of this node mapped by name.
protected final ArrayList<NodeComponent>	components	The components stored in a linear list.
protected final HashMap<Class<?>,NodeComponent>	componentsByClass	The components mapped by class.
protected final HashMap<String,Node>	fastMappedChildren	NOTE: Only subcommands will be stored here, no parameters as they have nothing to be mapped to.
protected final String	name	The primary name of this node.
protected final Node	parent	The immediate parent of this node.
protected Node	root	The root node of this tree.

Constructor Summary

Constructors

Constructor	Description
Node(String name, Node parent, Node root)	Constructor.

Method Summary

Modifier and Type	Method	Description
Node	addAliases(String... aliases)
Node	addChild(Node node)
Node	addChild(Node node, Consumer<Node> consumer)
Node	argument(ArgumentType<?> type)
Node	argument(ArgumentType<?> type, ArgumentOptions options)
<T extends NodeComponent> T	component(Class<T> tClass, Function<Node,T> constructor)
<T extends NodeComponent> Node	component(Class<T> tClass, Function<Node,T> constructor, BiConsumer<Node,T> consumer)
Node	executable()
Node	executable(Consumer<Executable> consumer)
Node	executes(Consumer<Context> executor)
Node	executes(CommandNodeExecutor executor)
Node	executes(CommandNodeExecutor executor, CommandNodeExecutor walked)
Node	findNext(Context context, net.orbyfied.j8.util.StringReader reader)
Node	flag(String name, Character ch, ArgumentType<?> type, boolean isSwitch)
Node	flag(String name, ArgumentType<?> type)
Node	flag(Flag<?> flag)
List<String>	getAliases()
Node	getChild(String name)
Node	getChildByName(String name)
Node	getChildByPath(String... path)
List<Node>	getChildren()
<T extends NodeComponent> T	getComponent(Class<T> klass)
<T> T	getComponentOf(Class<T> klass)
List<NodeComponent>	getComponents()
Map<Class<?>,NodeComponent>	getComponentsByClass()
Map<String,Node>	getFastMappedChildren()
String	getName()
Node	getOrCreateChild(String name, Function<Node,Node> constructor)
boolean	hasComponentOf(Class<?> klass)
<T extends NodeComponent> T	makeComponent(Function<Node,T> constructor)
<T extends NodeComponent> Node	makeComponent(Function<Node,T> constructor, Consumer<T> consumer)
Node	node()
Node	parent()
Node	permission(String perm)
void	printTreeFancy(PrintStream stream)
Node	propertied(String desc, String label, String usage)
Node	removeAlias(String... aliases)
Node	removeChild(Node node)
Node	removeComponent(Class<?> klass)
Node	removeComponent(NodeComponent component)
Node	root()
Node	setExecutor(Consumer<Context> executor)
Node	thenArgument(String name, ArgumentType<?> type)
Node	thenArgument(String name, ArgumentType<?> type, BiConsumer<Node,Argument> consumer)
Node	thenArgument(String name, ArgumentType<?> type, Consumer<Node> consumer)
Node	thenArgument(String name, ArgumentType<?> type, ArgumentOptions options)
Node	thenArgument(String name, ArgumentType<?> type, ArgumentOptions options, BiConsumer<Node,Argument> consumer)
Node	thenArgument(String name, ArgumentType<?> type, ArgumentOptions options, Consumer<Node> consumer)
Node	thenExecute(String name, Consumer<Context> executor)
Node	thenExecute(String name, Consumer<Context> executor, Consumer<Node> consumer)
Node	thenExecute(String name, CommandNodeExecutor executor)
Node	thenExecute(String name, CommandNodeExecutor executor, BiConsumer<Node,Executable> consumer)
Node	thenExecute(String name, CommandNodeExecutor executor, Consumer<Node> consumer)
Node	thenExecute(String name, CommandNodeExecutor executor, CommandNodeExecutor walked)
Node	thenExecute(String name, CommandNodeExecutor executor, CommandNodeExecutor walked, BiConsumer<Node,Executable> consumer)
boolean	walk(Context context, Node last, net.orbyfied.j8.util.StringReader fReader)	Walks this node in a dispatch chain, this node will handle it's own behaviour and then move on to the next or terminate the chain.
Node	withAliases(String... aliases)
<T extends NodeComponent> T	withComponent(T component)
<T extends NodeComponent> Node	withComponent(T component, Consumer<T> consumer)

Methods inherited from class java.lang.Object

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

Field Details

components

protected final ArrayList<NodeComponent> components

The components stored in a linear list.

componentsByClass

protected final HashMap<Class<?>,NodeComponent> componentsByClass

The components mapped by class. Includes all parent classes of a component which are not annotated with NonComponent

children

protected final ArrayList<Node> children

The children (subnodes/subcommands) of this node.

childrenByName

protected final HashMap<String,Node> childrenByName

The children (subnodes/subcommands) of this node mapped by name.

fastMappedChildren

protected final HashMap<String,Node> fastMappedChildren

NOTE: Only subcommands will be stored here, no parameters as they have nothing to be mapped to.

name

protected final String name

The primary name of this node.

aliases

protected final List<String> aliases

The aliases of this node.

parent

protected final Node parent

The immediate parent of this node.

root

protected Node root

The root node of this tree.

Constructor Details

Node

public Node(String name,
 Node parent,
 Node root)

Constructor.

Method Details

walk

public boolean walk(Context context,
 Node last,
 net.orbyfied.j8.util.StringReader fReader)

Walks this node in a dispatch chain, this node will handle it's own behaviour and then move on to the next or terminate the chain.

Parameters:

context - The command context.

last - The last node in the chain.

fReader - The string reader.

Returns:

If the chain has ended and should be back tracked further to the last executable.

findNext

public Node findNext(Context context,
 net.orbyfied.j8.util.StringReader reader)

node

public Node node()

getChildren

public List<Node> getChildren()

getFastMappedChildren

public Map<String,Node> getFastMappedChildren()

getComponents

public List<NodeComponent> getComponents()

getComponentsByClass

public Map<Class<?>,NodeComponent> getComponentsByClass()

parent

public Node parent()

getName

public String getName()

getAliases

public List<String> getAliases()

root

public Node root()

withAliases

public Node withAliases(String... aliases)

addAliases

public Node addAliases(String... aliases)

removeAlias

public Node removeAlias(String... aliases)

makeComponent

public <T extends NodeComponent> T makeComponent(Function<Node,T> constructor)

makeComponent

public <T extends NodeComponent> Node makeComponent(Function<Node,T> constructor,
 Consumer<T> consumer)

component

public <T extends NodeComponent> T component(Class<T> tClass,
 Function<Node,T> constructor)

component

public <T extends NodeComponent> Node component(Class<T> tClass,
 Function<Node,T> constructor,
 BiConsumer<Node,T> consumer)

withComponent

public <T extends NodeComponent> T withComponent(T component)

withComponent

public <T extends NodeComponent> Node withComponent(T component,
 Consumer<T> consumer)

removeComponent

public Node removeComponent(NodeComponent component)

removeComponent

public Node removeComponent(Class<?> klass)

getComponentOf

public <T> T getComponentOf(Class<T> klass)

getComponent

public <T extends NodeComponent> T getComponent(Class<T> klass)

hasComponentOf

public boolean hasComponentOf(Class<?> klass)

addChild

public Node addChild(Node node)

addChild

public Node addChild(Node node,
 Consumer<Node> consumer)

removeChild

public Node removeChild(Node node)

getChildByName

public Node getChildByName(String name)

getChildByPath

public Node getChildByPath(String... path)

getChild

public Node getChild(String name)

getOrCreateChild

public Node getOrCreateChild(String name,
 Function<Node,Node> constructor)

propertied

public Node propertied(String desc,
 String label,
 String usage)

executable

public Node executable()

executable

public Node executable(Consumer<Executable> consumer)

executes

public Node executes(CommandNodeExecutor executor)

setExecutor

public Node setExecutor(Consumer<Context> executor)

executes

public Node executes(Consumer<Context> executor)

executes

public Node executes(CommandNodeExecutor executor,
 CommandNodeExecutor walked)

argument

public Node argument(ArgumentType<?> type)

argument

public Node argument(ArgumentType<?> type,
 ArgumentOptions options)

permission

public Node permission(String perm)

flag

public Node flag(Flag<?> flag)

flag

public Node flag(String name,
 Character ch,
 ArgumentType<?> type,
 boolean isSwitch)

flag

public Node flag(String name,
 ArgumentType<?> type)

thenArgument

public Node thenArgument(String name,
 ArgumentType<?> type)

thenArgument

public Node thenArgument(String name,
 ArgumentType<?> type,
 Consumer<Node> consumer)

thenArgument

public Node thenArgument(String name,
 ArgumentType<?> type,
 BiConsumer<Node,Argument> consumer)

thenArgument

public Node thenArgument(String name,
 ArgumentType<?> type,
 ArgumentOptions options)

thenArgument

public Node thenArgument(String name,
 ArgumentType<?> type,
 ArgumentOptions options,
 Consumer<Node> consumer)

thenArgument

public Node thenArgument(String name,
 ArgumentType<?> type,
 ArgumentOptions options,
 BiConsumer<Node,Argument> consumer)

thenExecute

public Node thenExecute(String name,
 CommandNodeExecutor executor)

thenExecute

public Node thenExecute(String name,
 Consumer<Context> executor)

thenExecute

public Node thenExecute(String name,
 CommandNodeExecutor executor,
 Consumer<Node> consumer)

thenExecute

public Node thenExecute(String name,
 Consumer<Context> executor,
 Consumer<Node> consumer)

thenExecute

public Node thenExecute(String name,
 CommandNodeExecutor executor,
 BiConsumer<Node,Executable> consumer)

thenExecute

public Node thenExecute(String name,
 CommandNodeExecutor executor,
 CommandNodeExecutor walked)

thenExecute

public Node thenExecute(String name,
 CommandNodeExecutor executor,
 CommandNodeExecutor walked,
 BiConsumer<Node,Executable> consumer)

printTreeFancy

public void printTreeFancy(PrintStream stream)