Package cn.nukkit.command.data

Class CommandParameter

java.lang.Object

cn.nukkit.command.data.CommandParameter

public class CommandParameter
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ARG_TYPE_BLOCK_POS	Deprecated.
static final String	ARG_TYPE_BOOL	Deprecated.
static final String	ARG_TYPE_INT	Deprecated.
static final String	ARG_TYPE_PLAYER	Deprecated.
static final String	ARG_TYPE_RAW_TEXT	Deprecated.
static final String	ARG_TYPE_STRING	Deprecated.
static final String	ARG_TYPE_STRING_ENUM	Deprecated.
static final String	ARG_TYPE_TARGET	Deprecated.
static final CommandParameter[]	EMPTY_ARRAY
static final String	ENUM_TYPE_BLOCK_LIST	Deprecated.
static final String	ENUM_TYPE_COMMAND_LIST	Deprecated.
static final String	ENUM_TYPE_EFFECT_LIST	Deprecated.
static final String	ENUM_TYPE_ENCHANTMENT_LIST	Deprecated.
static final String	ENUM_TYPE_ENTITY_LIST	Deprecated.
static final String	ENUM_TYPE_ITEM_LIST	Deprecated.
static final String	ENUM_TYPE_PARTICLE_LIST	Deprecated.
CommandEnum	enumData
String	name
boolean	optional
byte	options	Deprecated.
IParamNode<?>	paramNode
List<CommandParamOption>	paramOptions
String	postFix
CommandParamType	type

Constructor Summary

Constructors

Constructor	Description
CommandParameter(String name)	Deprecated. use newType(String, CommandParamType) instead
CommandParameter(String name, boolean optional)	Deprecated. use newType(String, boolean, CommandParamType) instead
CommandParameter(String name, boolean optional, String enumType)	Deprecated. use newEnum(String, boolean, String) instead
CommandParameter(String name, boolean optional, String[] enumValues)	Deprecated. use newEnum(String, boolean, String[]) instead
CommandParameter(String name, CommandParamType type, boolean optional)	Deprecated. use newType(String, boolean, CommandParamType) instead
CommandParameter(String name, String enumType)	Deprecated. use newEnum(String, String) instead
CommandParameter(String name, String[] enumValues)	Deprecated. use newEnum(String, String[]) instead
CommandParameter(String name, String type, boolean optional)	Deprecated. use newType(String, boolean, CommandParamType) instead

Method Summary

Modifier and Type	Method	Description
protected static CommandParamType	fromString(String param)
static CommandParameter	newEnum(String name, boolean optional, CommandEnum data)	optional = false
static CommandParameter	newEnum(String name, boolean optional, CommandEnum data, CommandParamOption... options)	optional = false
static CommandParameter	newEnum(String name, boolean optional, CommandEnum data, IParamNode<?> paramNode)	optional = false
static CommandParameter	newEnum(String name, boolean optional, CommandEnum data, IParamNode<?> paramNode, CommandParamOption... options)	创建一个枚举参数
static CommandParameter	newEnum(String name, boolean optional, String type)	optional = false
static CommandParameter	newEnum(String name, boolean optional, String[] values)	CommandEnum.getName()为 name+"Enums"
static CommandParameter	newEnum(String name, boolean optional, String[] values, boolean isSoft)
static CommandParameter	newEnum(String name, CommandEnum data)	optional = false
static CommandParameter	newEnum(String name, String type)	optional = false
static CommandParameter	newEnum(String name, String[] values)	optional = false
static CommandParameter	newType(String name, boolean optional, CommandParamType type)	paramNode = null , CommandParamOption=[]
static CommandParameter	newType(String name, boolean optional, CommandParamType type, CommandParamOption... options)	paramNode = null
static CommandParameter	newType(String name, boolean optional, CommandParamType type, IParamNode<?> paramNode, CommandParamOption... options)	创建一个命令参数
static CommandParameter	newType(String name, CommandParamType type)	optional = false
static CommandParameter	newType(String name, CommandParamType type, IParamNode<?> paramNode)	optional = false,CommandParamOption=[]

Methods inherited from class java.lang.Object

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

Field Details

EMPTY_ARRAY

@PowerNukkitOnly
@Since("1.4.0.0-PN")
public static final CommandParameter[] EMPTY_ARRAY

name

public String name

type

public CommandParamType type

optional

public boolean optional

options

@Deprecated
@DeprecationDetails(since="1.19.20-r1",
                    reason="use CommandParamOption instead")
public byte options

Deprecated.

paramOptions

@PowerNukkitXOnly
@Since("1.19.20-r2")
public List<CommandParamOption> paramOptions

enumData

public CommandEnum enumData

postFix

public String postFix

paramNode

@PowerNukkitXOnly
@Since("1.19.60-r1")
public IParamNode<?> paramNode

ARG_TYPE_STRING

@Deprecated
@DeprecationDetails(since="1.4.0.0-PN",
                    reason="Removed from Cloudburst Nukkit")
@PowerNukkitOnly("Re-added for backward compatibility")
public static final String ARG_TYPE_STRING

Deprecated.

See Also:

• Constant Field Values

ARG_TYPE_STRING_ENUM

@Deprecated
@DeprecationDetails(since="1.4.0.0-PN",
                    reason="Removed from Cloudburst Nukkit")
@PowerNukkitOnly("Re-added for backward compatibility")
public static final String ARG_TYPE_STRING_ENUM

Deprecated.

See Also:

• Constant Field Values

ARG_TYPE_BOOL

@Deprecated
@DeprecationDetails(since="1.4.0.0-PN",
                    reason="Removed from Cloudburst Nukkit")
@PowerNukkitOnly("Re-added for backward compatibility")
public static final String ARG_TYPE_BOOL

Deprecated.

See Also:

• Constant Field Values

ARG_TYPE_TARGET

@Deprecated
@DeprecationDetails(since="1.4.0.0-PN",
                    reason="Removed from Cloudburst Nukkit")
@PowerNukkitOnly("Re-added for backward compatibility")
public static final String ARG_TYPE_TARGET

Deprecated.

See Also:

• Constant Field Values

ARG_TYPE_PLAYER

@Deprecated
@DeprecationDetails(since="1.4.0.0-PN",
                    reason="Removed from Cloudburst Nukkit")
@PowerNukkitOnly("Re-added for backward compatibility")
public static final String ARG_TYPE_PLAYER

Deprecated.

See Also:

• Constant Field Values

ARG_TYPE_BLOCK_POS

@Deprecated
@DeprecationDetails(since="1.4.0.0-PN",
                    reason="Removed from Cloudburst Nukkit")
@PowerNukkitOnly("Re-added for backward compatibility")
public static final String ARG_TYPE_BLOCK_POS

Deprecated.

See Also:

• Constant Field Values

ARG_TYPE_RAW_TEXT

@Deprecated
@DeprecationDetails(since="1.4.0.0-PN",
                    reason="Removed from Cloudburst Nukkit")
@PowerNukkitOnly("Re-added for backward compatibility")
public static final String ARG_TYPE_RAW_TEXT

Deprecated.

See Also:

• Constant Field Values

ARG_TYPE_INT

@Deprecated
@DeprecationDetails(since="1.4.0.0-PN",
                    reason="Removed from Cloudburst Nukkit")
@PowerNukkitOnly("Re-added for backward compatibility")
public static final String ARG_TYPE_INT

Deprecated.

See Also:

• Constant Field Values

ENUM_TYPE_ITEM_LIST

@Deprecated
@DeprecationDetails(since="1.4.0.0-PN",
                    reason="Removed from Cloudburst Nukkit")
@PowerNukkitOnly("Re-added for backward compatibility")
public static final String ENUM_TYPE_ITEM_LIST

Deprecated.

See Also:

• Constant Field Values

ENUM_TYPE_BLOCK_LIST

@Deprecated
@DeprecationDetails(since="1.4.0.0-PN",
                    reason="Removed from Cloudburst Nukkit")
@PowerNukkitOnly("Re-added for backward compatibility")
public static final String ENUM_TYPE_BLOCK_LIST

Deprecated.

See Also:

• Constant Field Values

ENUM_TYPE_COMMAND_LIST

@Deprecated
@DeprecationDetails(since="1.4.0.0-PN",
                    reason="Removed from Cloudburst Nukkit")
@PowerNukkitOnly("Re-added for backward compatibility")
public static final String ENUM_TYPE_COMMAND_LIST

Deprecated.

See Also:

• Constant Field Values

ENUM_TYPE_ENCHANTMENT_LIST

@Deprecated
@DeprecationDetails(since="1.4.0.0-PN",
                    reason="Removed from Cloudburst Nukkit")
@PowerNukkitOnly("Re-added for backward compatibility")
public static final String ENUM_TYPE_ENCHANTMENT_LIST

Deprecated.

See Also:

• Constant Field Values

ENUM_TYPE_ENTITY_LIST

@Deprecated
@DeprecationDetails(since="1.4.0.0-PN",
                    reason="Removed from Cloudburst Nukkit")
@PowerNukkitOnly("Re-added for backward compatibility")
public static final String ENUM_TYPE_ENTITY_LIST

Deprecated.

See Also:

• Constant Field Values

ENUM_TYPE_EFFECT_LIST

@Deprecated
@DeprecationDetails(since="1.4.0.0-PN",
                    reason="Removed from Cloudburst Nukkit")
@PowerNukkitOnly("Re-added for backward compatibility")
public static final String ENUM_TYPE_EFFECT_LIST

Deprecated.

See Also:

• Constant Field Values

ENUM_TYPE_PARTICLE_LIST

@Deprecated
@DeprecationDetails(since="1.4.0.0-PN",
                    reason="Removed from Cloudburst Nukkit")
@PowerNukkitOnly("Re-added for backward compatibility")
public static final String ENUM_TYPE_PARTICLE_LIST

Deprecated.

See Also:

• Constant Field Values

Constructor Details

CommandParameter

@Deprecated
@DeprecationDetails(since="1.4.0.0-PN",
                    reason="Deprecated by Cloudburst Nukkit",
                    replaceWith="newType(String, boolean, CommandParamType)")
public CommandParameter(String name,
 String type,
 boolean optional)

Deprecated.

use newType(String, boolean, CommandParamType) instead

CommandParameter

@Deprecated
@DeprecationDetails(since="1.4.0.0-PN",
                    reason="Deprecated by Cloudburst Nukkit",
                    replaceWith="newType(String, boolean, CommandParamType)")
public CommandParameter(String name,
 CommandParamType type,
 boolean optional)

Deprecated.

use newType(String, boolean, CommandParamType) instead

CommandParameter

@Deprecated
@DeprecationDetails(since="1.4.0.0-PN",
                    reason="Deprecated by Cloudburst Nukkit",
                    replaceWith="newType(String, boolean, CommandParamType)")
public CommandParameter(String name,
 boolean optional)

Deprecated.

use newType(String, boolean, CommandParamType) instead

CommandParameter

@Deprecated
@DeprecationDetails(since="1.4.0.0-PN",
                    reason="Deprecated by Cloudburst Nukkit",
                    replaceWith="newType(String, CommandParamType)")
public CommandParameter(String name)

Deprecated.

use newType(String, CommandParamType) instead

CommandParameter

@Deprecated
@DeprecationDetails(since="1.4.0.0-PN",
                    reason="Deprecated by Cloudburst Nukkit",
                    replaceWith="newEnum(String, boolean, String)")
public CommandParameter(String name,
 boolean optional,
 String enumType)

Deprecated.

use newEnum(String, boolean, String) instead

CommandParameter

@Deprecated
@DeprecationDetails(since="1.4.0.0-PN",
                    reason="Deprecated by Cloudburst Nukkit",
                    replaceWith="newEnum(String, boolean, String[])")
public CommandParameter(String name,
 boolean optional,
 String[] enumValues)

Deprecated.

use newEnum(String, boolean, String[]) instead

CommandParameter

@Deprecated
@DeprecationDetails(since="1.4.0.0-PN",
                    reason="Deprecated by Cloudburst Nukkit",
                    replaceWith="newEnum(String, String)")
public CommandParameter(String name,
 String enumType)

Deprecated.

use newEnum(String, String) instead

CommandParameter

@Deprecated
@DeprecationDetails(since="1.4.0.0-PN",
                    reason="Deprecated by Cloudburst Nukkit",
                    replaceWith="newEnum(String, String[])")
public CommandParameter(String name,
 String[] enumValues)

Deprecated.

use newEnum(String, String[]) instead

Method Details

newType

@Since("1.4.0.0-PN")
public static CommandParameter newType(String name,
 CommandParamType type)

optional = false

See Also:

• newType(String name, boolean, CommandParamType type)

newType

@PowerNukkitXOnly
@Since("1.19.50-r3")
public static CommandParameter newType(String name,
 CommandParamType type,
 IParamNode<?> paramNode)

optional = false,CommandParamOption=[]

See Also:

• newType(String, boolean, CommandParamType, IParamNode, CommandParamOption...)

newType

@Since("1.4.0.0-PN")
public static CommandParameter newType(String name,
 boolean optional,
 CommandParamType type)

paramNode = null , CommandParamOption=[]

See Also:

• newType(String, boolean, CommandParamType, IParamNode, CommandParamOption...)

newType

@PowerNukkitXOnly
@Since("1.19.60-r1")
public static CommandParameter newType(String name,
 boolean optional,
 CommandParamType type,
 CommandParamOption... options)

paramNode = null

See Also:

• newType(String, boolean, CommandParamType, IParamNode, CommandParamOption...)

newType

@PowerNukkitXOnly
@Since("1.19.60-r1")
public static CommandParameter newType(String name,
 boolean optional,
 CommandParamType type,
 IParamNode<?> paramNode,
 CommandParamOption... options)

创建一个命令参数

Parameters:

name - 参数名

optional - 该参数是否为可选参数

type - 类型CommandParamType

paramNode - 用于解析该参数的参数节点

options - the options

Returns:

the command parameter

newEnum

@Since("1.4.0.0-PN")
public static CommandParameter newEnum(String name,
 String[] values)

optional = false

See Also:

• newEnum(String name, boolean optional, String[] values)

newEnum

@Since("1.4.0.0-PN")
public static CommandParameter newEnum(String name,
 boolean optional,
 String[] values)

CommandEnum.getName()为 name+"Enums"

isSoft = false

See Also:

• newEnum(String name, boolean optional, CommandEnum data)

newEnum

@PowerNukkitXOnly
@Since("1.19.60-r1")
public static CommandParameter newEnum(String name,
 boolean optional,
 String[] values,
 boolean isSoft)

See Also:

• newEnum(String name, boolean optional, CommandEnum data)

newEnum

@Since("1.4.0.0-PN")
public static CommandParameter newEnum(String name,
 String type)

optional = false

See Also:

• newEnum(String, boolean, CommandEnum, IParamNode, CommandParamOption...)

newEnum

@Since("1.4.0.0-PN")
public static CommandParameter newEnum(String name,
 boolean optional,
 String type)

optional = false

See Also:

• newEnum(String, boolean, CommandEnum, IParamNode, CommandParamOption...)

newEnum

@Since("1.4.0.0-PN")
public static CommandParameter newEnum(String name,
 CommandEnum data)

optional = false

See Also:

• newEnum(String, boolean, CommandEnum)

newEnum

@Since("1.4.0.0-PN")
public static CommandParameter newEnum(String name,
 boolean optional,
 CommandEnum data)

optional = false

See Also:

• newEnum(String, boolean, CommandEnum, IParamNode, CommandParamOption...)

newEnum

@PowerNukkitXOnly
@Since("1.19.60-r1")
public static CommandParameter newEnum(String name,
 boolean optional,
 CommandEnum data,
 CommandParamOption... options)

optional = false

See Also:

• newEnum(String, boolean, CommandEnum, IParamNode, CommandParamOption...)

newEnum

@PowerNukkitXOnly
@Since("1.19.60-r1")
public static CommandParameter newEnum(String name,
 boolean optional,
 CommandEnum data,
 IParamNode<?> paramNode)

optional = false

See Also:

• newEnum(String, boolean, CommandEnum, IParamNode, CommandParamOption...)

newEnum

@PowerNukkitXOnly
@Since("1.19.60-r1")
public static CommandParameter newEnum(String name,
 boolean optional,
 CommandEnum data,
 IParamNode<?> paramNode,
 CommandParamOption... options)

创建一个枚举参数

Parameters:

name - 参数名称

optional - 改参数是否可选

data - 枚举数据CommandEnum,其中的CommandEnum.getName()才是真正的枚举参数名

paramNode - 该参数对应的IParamNode

options - the options

Returns:

the command parameter

fromString

protected static CommandParamType fromString(String param)