Class LiteralArgument

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.LiteralArgument

All Implemented Interfaces:

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

public class LiteralArgument
extends Argument<String>
implements Literal<Argument<String>>

A pseudo-argument representing a single literal string

Since:

1.3

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
LiteralArgument(String literal)	A literal argument.
LiteralArgument(String nodeName, String literal)	A literal argument.

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	getHelpString()
String	getLiteral()	Returns the literal string represented by this argument
Class<String>	getPrimitiveType()
static LiteralArgument	literal(String literal)	A utility method to create a literal argument.
static LiteralArgument	literal(String nodeName, String literal)	A utility method to create a literal argument.
static LiteralArgument	of(String literal)	A utility method to create a literal argument.
static LiteralArgument	of(String nodeName, String literal)	A utility method to create a literal argument.
<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 Argument

instance

Modifier and Type	Method	Description
Argument<String>	instance()

Methods inherited from class AbstractArgument

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

Methods inherited from class AbstractArgumentTree

then, thenNested, thenNested

Methods inherited from class Object

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

Methods inherited from interface 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

Modifier and Type	Method	Description
default Argument<String>	executes(CommandExecutionInfo executor, ExecutorType... types)	Adds an executor to the current command builder
default Argument<String>	executes(CommandExecutor executor, ExecutorType... types)	Adds an executor to the current command builder
default Argument<String>	executes(ResultingCommandExecutionInfo executor, ExecutorType... types)	Adds an executor to the current command builder
default Argument<String>	executes(ResultingCommandExecutor executor, ExecutorType... types)	Adds an executor to the current command builder
default Argument<String>	executesCommandBlock(CommandBlockCommandExecutor executor)	Adds an executor to the current command builder
default Argument<String>	executesCommandBlock(CommandBlockExecutionInfo info)	Adds an executor to the current command builder
default Argument<String>	executesCommandBlock(CommandBlockResultingCommandExecutor executor)	Adds an executor to the current command builder
default Argument<String>	executesCommandBlock(CommandBlockResultingExecutionInfo info)	Adds an executor to the current command builder
default Argument<String>	executesConsole(ConsoleCommandExecutor executor)	Adds an executor to the current command builder
default Argument<String>	executesConsole(ConsoleExecutionInfo info)	Adds an executor to the current command builder
default Argument<String>	executesConsole(ConsoleResultingCommandExecutor executor)	Adds an executor to the current command builder
default Argument<String>	executesConsole(ConsoleResultingExecutionInfo info)	Adds an executor to the current command builder
default Argument<String>	executesEntity(EntityCommandExecutor executor)	Adds an executor to the current command builder
default Argument<String>	executesEntity(EntityExecutionInfo info)	Adds an executor to the current command builder
default Argument<String>	executesEntity(EntityResultingCommandExecutor executor)	Adds an executor to the current command builder
default Argument<String>	executesEntity(EntityResultingExecutionInfo info)	Adds an executor to the current command builder
default Argument<String>	executesFeedbackForwarding(FeedbackForwardingCommandExecutor executor)	Adds an executor to the current command builder
default Argument<String>	executesFeedbackForwarding(FeedbackForwardingExecutionInfo info)	Adds an executor to the current command builder
default Argument<String>	executesFeedbackForwarding(FeedbackForwardingResultingCommandExecutor executor)	Adds an executor to the current command builder
default Argument<String>	executesFeedbackForwarding(FeedbackForwardingResultingExecutionInfo info)	Adds an executor to the current command builder
default Argument<String>	executesNative(NativeCommandExecutor executor)	Adds an executor to the current command builder
default Argument<String>	executesNative(NativeExecutionInfo info)	Adds an executor to the current command builder
default Argument<String>	executesNative(NativeResultingCommandExecutor executor)	Adds an executor to the current command builder
default Argument<String>	executesNative(NativeResultingExecutionInfo info)	Adds an executor to the current command builder
default Argument<String>	executesPlayer(PlayerCommandExecutor executor)	Adds an executor to the current command builder
default Argument<String>	executesPlayer(PlayerExecutionInfo info)	Adds an executor to the current command builder
default Argument<String>	executesPlayer(PlayerResultingCommandExecutor executor)	Adds an executor to the current command builder
default Argument<String>	executesPlayer(PlayerResultingExecutionInfo info)	Adds an executor to the current command builder
default Argument<String>	executesProxy(ProxyCommandExecutor executor)	Adds an executor to the current command builder
default Argument<String>	executesProxy(ProxyExecutionInfo info)	Adds an executor to the current command builder
default Argument<String>	executesProxy(ProxyResultingCommandExecutor executor)	Adds an executor to the current command builder
default Argument<String>	executesProxy(ProxyResultingExecutionInfo info)	Adds an executor to the current command builder
default Argument<String>	executesRemoteConsole(RemoteConsoleCommandExecutor executor)	Adds an executor to the current command builder
default Argument<String>	executesRemoteConsole(RemoteConsoleExecutionInfo info)	Adds an executor to the current command builder
default Argument<String>	executesRemoteConsole(RemoteConsoleResultingCommandExecutor executor)	Adds an executor to the current command builder
default Argument<String>	executesRemoteConsole(RemoteConsoleResultingExecutionInfo info)	Adds an executor to the current command builder

Methods inherited from interface PlatformExecutable

getExecutor

Field Details

executor

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

Constructor Details

LiteralArgument

public LiteralArgument(String literal)

A literal argument. Only takes one string value which cannot be modified

Parameters:

literal - the string literal that this argument will represent. Also acts as this argument's node name

LiteralArgument

public LiteralArgument(String nodeName,
 String literal)

A literal argument. Only takes one string value which cannot be modified

Parameters:

nodeName - the node name for this argument

literal - the string literal that this argument will represent

Method Details

getPrimitiveType

public Class<String> getPrimitiveType()

Specified by:

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

of

public static LiteralArgument of(String literal)

A utility method to create a literal argument. Works as an alternative to literal(String)

To provide easier use of this method you can statically import this: import static dev.jorel.commandapi.arguments.LiteralArgument.of;

Parameters:

literal - the string literal that this argument will represent

Returns:

the literal argument created by this method

literal

public static LiteralArgument literal(String literal)

A utility method to create a literal argument. Works as an alternative to of(String)

To provide easier use of this method you can statically import this: import static dev.jorel.commandapi.arguments.LiteralArgument.literal;

Parameters:

literal - the string literal that this argument will represent

Returns:

the literal argument created by this method

of

public static LiteralArgument of(String nodeName,
 String literal)

A utility method to create a literal argument. Works as an alternative to literal(String, String)

To provide easier use of this method you can statically import this: import static dev.jorel.commandapi.arguments.LiteralArgument.of;

Parameters:

literal - the string literal that this argument will represent

Returns:

the literal argument created by this method

literal

public static LiteralArgument literal(String nodeName,
 String literal)

A utility method to create a literal argument. Works as an alternative to of(String, String)

To provide easier use of this method you can statically import this: import static dev.jorel.commandapi.arguments.LiteralArgument.literal;

Parameters:

literal - the string literal that this argument will represent

Returns:

the literal argument created by this method

getLiteral

public String getLiteral()

Returns the literal string represented by this argument

Specified by:

getLiteral in interface Literal<Argument<String>>

Returns:

the literal string represented by this argument

getArgumentType

public CommandAPIArgumentType getArgumentType()

Specified by:

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

getHelpString

public String getHelpString()

Overrides:

getHelpString 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()