Package studio.mevera.imperat.command.tree

Class ParameterNode<S extends Source,T extends CommandParameter<S>>

java.lang.Object

studio.mevera.imperat.command.tree.ParameterNode<S,T>

Direct Known Subclasses:

ArgumentNode, CommandNode

public abstract class ParameterNode<S extends Source,T extends CommandParameter<S>>
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final T	data
protected @Nullable CommandUsage<S>	executableUsage

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ParameterNode(@Nullable ParameterNode<S,?> parent, T data, int depth, @Nullable CommandUsage<S> executableUsage)

Method Summary

Modifier and Type	Method	Description
void	addChild(ParameterNode<S,?> node)
void	addSupportedType(ParameterType<S,?> type)
static <S extends Source> ArgumentNode<S>	createArgumentNode(ParameterNode<S,?> parent, CommandParameter<S> data, int depth, @Nullable CommandUsage<S> executableUsage)
static <S extends Source> CommandNode<S>	createCommandNode(@Nullable ParameterNode<S,?> parent, @NotNull Command<S> data, int depth, @Nullable CommandUsage<S> executableUsage)
boolean	equals(Object o)
abstract String	format()
@Nullable ParameterNode<S,?>	getChild(Predicate<ParameterNode<S,?>> predicate)
LinkedList<ParameterNode<S,?>>	getChildren()
int	getConsumedArguments()
T	getData()
int	getDepth()
@Nullable CommandUsage<S>	getExecutableUsage()
ParameterNode<S,?>	getNextCommandChild()
ParameterNode<S,?>	getNextParameterChild()
@Nullable ParameterNode<S,?>	getParent()
String	getPermission()
@Nullable ParameterType<S,?>	getPrimaryType()
Deque<ParameterType<S,?>>	getSupportedTypes()
@Nullable ParameterNode<S,?>	getTopChild()
int	hashCode()
boolean	isCommand()
boolean	isExecutable()
boolean	isFlag()
boolean	isGreedyParam()
boolean	isLast()
boolean	isOptional()
boolean	isRequired()
boolean	isRoot()
boolean	isTrueFlag()
boolean	matchesInput(int depth, Context<S> ctx)
boolean	matchesInput(int depth, Context<S> ctx, boolean strict)
abstract int	priority()
void	removeSupportedType(ParameterType<S,?> type)
void	setExecutableUsage(@Nullable CommandUsage<S> executableUsage)
void	setPermission(String permission)

Methods inherited from class java.lang.Object

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

Field Details

data

@NotNull
protected final T extends CommandParameter<S> data

executableUsage

@Nullable
protected @Nullable CommandUsage<S extends Source> executableUsage

Constructor Details

ParameterNode

protected ParameterNode(@Nullable
 @Nullable ParameterNode<S,?> parent,
 @NotNull
 T data,
 int depth,
 @Nullable
 @Nullable CommandUsage<S> executableUsage)

Method Details

createCommandNode

public static <S extends Source> CommandNode<S> createCommandNode(@Nullable
 @Nullable ParameterNode<S,?> parent,
 @NotNull
 @NotNull Command<S> data,
 int depth,
 @Nullable
 @Nullable CommandUsage<S> executableUsage)

createArgumentNode

public static <S extends Source> ArgumentNode<S> createArgumentNode(ParameterNode<S,?> parent,
 CommandParameter<S> data,
 int depth,
 @Nullable
 @Nullable CommandUsage<S> executableUsage)

getPermission

public String getPermission()

setPermission

public void setPermission(String permission)

getDepth

public int getDepth()

getExecutableUsage

@Nullable
public @Nullable CommandUsage<S> getExecutableUsage()

setExecutableUsage

public void setExecutableUsage(@Nullable
 @Nullable CommandUsage<S> executableUsage)

isExecutable

public boolean isExecutable()

getData

@NotNull
public T getData()

addChild

public void addChild(ParameterNode<S,?> node)

getChildren

public LinkedList<ParameterNode<S,?>> getChildren()

matchesInput

public boolean matchesInput(int depth,
 Context<S> ctx)

matchesInput

public boolean matchesInput(int depth,
 Context<S> ctx,
 boolean strict)

addSupportedType

public void addSupportedType(ParameterType<S,?> type)

removeSupportedType

public void removeSupportedType(ParameterType<S,?> type)

getSupportedTypes

public Deque<ParameterType<S,?>> getSupportedTypes()

getPrimaryType

@Nullable
public @Nullable ParameterType<S,?> getPrimaryType()

format

public abstract String format()

isLast

public boolean isLast()

priority

public abstract int priority()

isGreedyParam

public boolean isGreedyParam()

isOptional

public boolean isOptional()

getChild

@Nullable
public @Nullable ParameterNode<S,?> getChild(Predicate<ParameterNode<S,?>> predicate)

getNextCommandChild

public ParameterNode<S,?> getNextCommandChild()

getNextParameterChild

public ParameterNode<S,?> getNextParameterChild()

isRequired

public boolean isRequired()

isCommand

public boolean isCommand()

isTrueFlag

public boolean isTrueFlag()

isFlag

public boolean isFlag()

getParent

@Nullable
public @Nullable ParameterNode<S,?> getParent()

getTopChild

@Nullable
public @Nullable ParameterNode<S,?> getTopChild()

isRoot

public boolean isRoot()

getConsumedArguments

public int getConsumedArguments()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object