Package dev.jorel.commandapi.arguments

Class LiteralArgument

java.lang.Object

dev.jorel.commandapi.AbstractArgumentTree<Argument<String>,Argument<?>,com.velocitypowered.api.command.CommandSource>

dev.jorel.commandapi.arguments.AbstractArgument<String,Argument<String>,Argument<?>,com.velocitypowered.api.command.CommandSource>

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

dev.jorel.commandapi.arguments.LiteralArgument

All Implemented Interfaces:

Literal<Argument<String>>, ChainableBuilder<Argument<String>>, PlatformExecutable<Argument<String>,com.velocitypowered.api.command.CommandSource>, VelocityExecutable<Argument<String>>

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

A pseudo-argument representing a single literal string

Field Summary

Fields

Modifier and Type	Field	Description
protected CommandAPIExecutor<com.velocitypowered.api.command.CommandSource,AbstractCommandSender<? extends com.velocitypowered.api.command.CommandSource>>	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<com.velocitypowered.api.command.CommandSource,AbstractCommandSender<? extends com.velocitypowered.api.command.CommandSource>>	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<com.velocitypowered.api.command.CommandSource,AbstractCommandSender<? extends com.velocitypowered.api.command.CommandSource>> 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, 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, thenNested, thenNested

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.jorel.commandapi.ChainableBuilder

instance

Methods inherited from interface dev.jorel.commandapi.PlatformExecutable

getExecutor

Methods inherited from interface dev.jorel.commandapi.VelocityExecutable

executes, executes, executes, executes, executesConsole, executesConsole, executesConsole, executesConsole, executesPlayer, executesPlayer, executesPlayer, executesPlayer

Field Details

executor

protected CommandAPIExecutor<com.velocitypowered.api.command.CommandSource,AbstractCommandSender<? extends com.velocitypowered.api.command.CommandSource>> 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

LiteralArgument

public LiteralArgument(String nodeName,
 String literal)

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

Parameters:

literal - the string literal that this argument will represent

Method Details

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

getPrimitiveType

public Class<String> getPrimitiveType()

Specified by:

getPrimitiveType in class AbstractArgument<String,Argument<String>,Argument<?>,com.velocitypowered.api.command.CommandSource>

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<?>,com.velocitypowered.api.command.CommandSource>

getHelpString

public String getHelpString()

Overrides:

getHelpString in class AbstractArgument<String,Argument<String>,Argument<?>,com.velocitypowered.api.command.CommandSource>

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<?>,com.velocitypowered.api.command.CommandSource>

Throws:

com.mojang.brigadier.exceptions.CommandSyntaxException

getExecutor

public CommandAPIExecutor<com.velocitypowered.api.command.CommandSource,AbstractCommandSender<? extends com.velocitypowered.api.command.CommandSource>> getExecutor()

setExecutor

public void setExecutor(CommandAPIExecutor<com.velocitypowered.api.command.CommandSource,AbstractCommandSender<? extends com.velocitypowered.api.command.CommandSource>> arg0)

clearExecutors

public Argument<String> clearExecutors()