Package cn.nukkit.command.tree.node

Class ParamNode<T>

java.lang.Object

cn.nukkit.command.tree.node.ParamNode<T>

All Implemented Interfaces:

IParamNode<T>

Direct Known Subclasses:

BlockNode, BooleanNode, CommandNode, DoubleNode, EnumNode, FloatNode, IntNode, IPlayersNode, ItemNode, MessageStringNode, PositionNode, RawTextNode, RemainStringNode, StringNode, TargetNode, WildcardIntNode, XpLevelNode

@PowerNukkitXOnly
@Since("1.19.60-r1")
public abstract class ParamNode<T>
extends Object
implements IParamNode<T>

一个通用的命令节点抽象类实现，插件想实现自己的命令参数节点应该继承这个类实现。

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	optional
protected ParamList	parent
protected T	value

Constructor Summary

Constructors

Constructor	Description
ParamNode()

Method Summary

Modifier and Type	Method	Description
<E> E	get()	获取已被IParamNode.fill(String)填充后的节点值,会自动转型为接受类型E,不会判断是否能成功转型 有可能抛出ClassCastException
ParamList	getParent()	获取该节点所属ParamList
boolean	hasResult()	该节点是否已经得到结果 该方法返回值为false时,将会一直重复对该节点执行填充IParamNode.fill(String)直到该方法返回true或者命令输入参数用完
IParamNode<T>	init(ParamList parent, String name, boolean optional, CommandParamType type, CommandEnum enumData, String postFix)	这个方法用于初始化ParamList和一些能从CommandParameter得到的参数,例如optional enumData等，插件不需要调用
boolean	isOptional()	该命令节点是否为可选值,可选值不一定需要被填充IParamNode.fill(String)
void	reset()	将节点重置回初始化状态,以待下次填充IParamNode.fill(String)

Methods inherited from class java.lang.Object

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

Methods inherited from interface cn.nukkit.command.tree.node.IParamNode

error, error, error, error, fill

Field Details

value

protected T value

optional

protected boolean optional

parent

protected ParamList parent

Constructor Details

ParamNode

public ParamNode()

Method Details

get

public <E> E get()

Description copied from interface: IParamNode

获取已被IParamNode.fill(String)填充后的节点值,会自动转型为接受类型E,不会判断是否能成功转型
有可能抛出ClassCastException

Specified by:

get in interface IParamNode<T>

hasResult

public boolean hasResult()

Description copied from interface: IParamNode

该节点是否已经得到结果
该方法返回值为false时,将会一直重复对该节点执行填充IParamNode.fill(String)直到该方法返回true或者命令输入参数用完

Specified by:

hasResult in interface IParamNode<T>

reset

public void reset()

Description copied from interface: IParamNode

将节点重置回初始化状态,以待下次填充IParamNode.fill(String)

Specified by:

reset in interface IParamNode<T>

isOptional

public boolean isOptional()

Description copied from interface: IParamNode

该命令节点是否为可选值,可选值不一定需要被填充IParamNode.fill(String)

Specified by:

isOptional in interface IParamNode<T>

getParent

public ParamList getParent()

Description copied from interface: IParamNode

获取该节点所属ParamList

Specified by:

getParent in interface IParamNode<T>

Returns:

the parent

init

public IParamNode<T> init(ParamList parent,
 String name,
 boolean optional,
 CommandParamType type,
 CommandEnum enumData,
 String postFix)

Description copied from interface: IParamNode

这个方法用于初始化ParamList和一些能从CommandParameter得到的参数,例如optional enumData等，插件不需要调用

Specified by:

init in interface IParamNode<T>

Parameters:

parent - the parent

name - the name

optional - the optional

type - the type

enumData - the enum data

postFix - the post fix

Returns:

the param node