Package dev.jorel.commandapi.arguments

Class MultiLiteralArgument

java.lang.Object

dev.jorel.commandapi.AbstractArgumentTree<Argument<String>,Argument<?>,org.bukkit.command.CommandSender>

dev.jorel.commandapi.arguments.AbstractArgument<String,Argument<String>,Argument<?>,org.bukkit.command.CommandSender>

dev.jorel.commandapi.arguments.Argument<String>

dev.jorel.commandapi.arguments.MultiLiteralArgument

All Implemented Interfaces:

MultiLiteral<Argument<String>>, BukkitExecutable<Argument<String>>, ChainableBuilder<Argument<String>>, PlatformExecutable<Argument<String>,org.bukkit.command.CommandSender>

public class MultiLiteralArgument
extends Argument<String>
implements MultiLiteral<Argument<String>>

An argument that represents multiple LiteralArguments

Since:

4.1

Field Summary

Fields

Modifier and Type	Field	Description
protected CommandAPIExecutor<org.bukkit.command.CommandSender,AbstractCommandSender<? extends org.bukkit.command.CommandSender>>	executor

Constructor Summary

Constructors

Constructor	Description
MultiLiteralArgument(String[] literals)	Deprecated, for removal: This API element is subject to removal in a future version. Use MultiLiteralArgument(String, String...) instead
MultiLiteralArgument(String nodeName, String... literals)	A multiliteral argument.
MultiLiteralArgument(String nodeName, List<String> literals)	Deprecated, for removal: This API element is subject to removal in a future version. Use MultiLiteralArgument(String, String...) instead

Method Summary

Modifier and Type	Method	Description
Argument<String>	clearExecutors()
CommandAPIArgumentType	getArgumentType()
CommandAPIExecutor<org.bukkit.command.CommandSender,AbstractCommandSender<? extends org.bukkit.command.CommandSender>>	getExecutor()
String[]	getLiterals()	Returns the literals that are present in this argument
Class<String>	getPrimitiveType()
<Source> String	parseArgument(com.mojang.brigadier.context.CommandContext<Source> cmdCtx, String key, CommandArguments previousArgs)
void	setExecutor(CommandAPIExecutor<org.bukkit.command.CommandSender,AbstractCommandSender<? extends org.bukkit.command.CommandSender>> arg0)

Methods inherited from class dev.jorel.commandapi.arguments.Argument

instance

Methods inherited from class dev.jorel.commandapi.arguments.AbstractArgument

combineWith, copyPermissionsAndRequirements, getArgumentPermission, getCombinedArguments, getEntityNames, getHelpString, getIncludedSuggestions, getNodeName, getOverriddenSuggestions, getRawType, getRequirements, hasCombinedArguments, includeSuggestions, isListed, isOptional, replaceSuggestions, setListed, setOptional, toString, withPermission, withPermission, withRequirement

Methods inherited from class dev.jorel.commandapi.AbstractArgumentTree

then

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.jorel.commandapi.BukkitExecutable

executes, executes, executes, executes, executesCommandBlock, executesCommandBlock, executesCommandBlock, executesCommandBlock, executesConsole, executesConsole, executesConsole, executesConsole, executesEntity, executesEntity, executesEntity, executesEntity, executesFeedbackForwarding, executesFeedbackForwarding, executesFeedbackForwarding, executesFeedbackForwarding, executesNative, executesNative, executesNative, executesNative, executesPlayer, executesPlayer, executesPlayer, executesPlayer, executesProxy, executesProxy, executesProxy, executesProxy, executesRemoteConsole, executesRemoteConsole, executesRemoteConsole, executesRemoteConsole

Methods inherited from interface dev.jorel.commandapi.ChainableBuilder

instance

Methods inherited from interface dev.jorel.commandapi.PlatformExecutable

getExecutor

Field Details

executor

protected CommandAPIExecutor<org.bukkit.command.CommandSender,AbstractCommandSender<? extends org.bukkit.command.CommandSender>> executor

Constructor Details

MultiLiteralArgument

public MultiLiteralArgument(String nodeName,
 String... literals)

A multiliteral argument. Takes in string literals which cannot be modified

Parameters:

nodeName - the node name for this argument

literals - the literals that this argument represents

MultiLiteralArgument

@Deprecated(since="9.0.2",
            forRemoval=true)
public MultiLiteralArgument(String[] literals)

Deprecated, for removal: This API element is subject to removal in a future version.

Use MultiLiteralArgument(String, String...) instead

A multiliteral argument. Takes in string literals which cannot be modified

Parameters:

literals - the literals that this argument represents

MultiLiteralArgument

@Deprecated(since="9.1.0",
            forRemoval=true)
public MultiLiteralArgument(String nodeName,
 List<String> literals)

Deprecated, for removal: This API element is subject to removal in a future version.

Use MultiLiteralArgument(String, String...) instead

A multiliteral argument. Takes in string literals which cannot be modified

Parameters:

nodeName - the node name for this argument

literals - the literals that this argument represents

Method Details

getPrimitiveType

public Class<String> getPrimitiveType()

Specified by:

getPrimitiveType in class AbstractArgument<String,Argument<String>,Argument<?>,org.bukkit.command.CommandSender>

getLiterals

public String[] getLiterals()

Returns the literals that are present in this argument

Specified by:

getLiterals in interface MultiLiteral<Argument<String>>

Returns:

the literals that are present in this argument

getArgumentType

public CommandAPIArgumentType getArgumentType()

Specified by:

getArgumentType in class AbstractArgument<String,Argument<String>,Argument<?>,org.bukkit.command.CommandSender>

parseArgument

public <Source> String parseArgument(com.mojang.brigadier.context.CommandContext<Source> cmdCtx,
 String key,
 CommandArguments previousArgs)
                              throws com.mojang.brigadier.exceptions.CommandSyntaxException

Specified by:

parseArgument in class AbstractArgument<String,Argument<String>,Argument<?>,org.bukkit.command.CommandSender>

Throws:

com.mojang.brigadier.exceptions.CommandSyntaxException

getExecutor

public CommandAPIExecutor<org.bukkit.command.CommandSender,AbstractCommandSender<? extends org.bukkit.command.CommandSender>> getExecutor()

setExecutor

public void setExecutor(CommandAPIExecutor<org.bukkit.command.CommandSender,AbstractCommandSender<? extends org.bukkit.command.CommandSender>> arg0)

clearExecutors

public Argument<String> clearExecutors()