Class Argument<T>

java.lang.Object

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

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

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

Type Parameters:

T - The type of the underlying object that this argument casts to

All Implemented Interfaces:

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

Direct Known Subclasses:

BlockPredicateArgument, BlockStateArgument, CommandArgument, EntitySelectorArgument.ManyEntities, EntitySelectorArgument.ManyPlayers, EntitySelectorArgument.OneEntity, EntitySelectorArgument.OnePlayer, ItemStackPredicateArgument, ListArgumentCommon, LiteralArgument, MapArgument, MultiLiteralArgument, ObjectiveCriteriaArgument, SafeOverrideableArgument, ScoreHolderArgument.Multiple, ScoreHolderArgument.Single, StringArgument, TextArgument

public abstract class Argument<T>
extends AbstractArgument<T, Argument<T>, Argument<?>, org.bukkit.command.CommandSender>
implements BukkitExecutable<Argument<T>>

The core abstract class for Command API arguments

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Argument(String nodeName, Supplier<com.mojang.brigadier.arguments.ArgumentType<?>> rawType)	Constructs an argument with a given NMS/brigadier type.

Method Summary

Modifier and Type	Method	Description
Argument<T>	clearExecutors()
CommandAPIExecutor<org.bukkit.command.CommandSender, AbstractCommandSender<? extends org.bukkit.command.CommandSender>>	getExecutor()
Argument<T>	instance()
void	setExecutor(CommandAPIExecutor<org.bukkit.command.CommandSender, AbstractCommandSender<? extends org.bukkit.command.CommandSender>> arg0)

Methods inherited from class AbstractArgument

combineWith, copyPermissionsAndRequirements, getArgumentPermission, getArgumentType, getCombinedArguments, getEntityNames, getHelpString, getIncludedSuggestions, getNodeName, getOverriddenSuggestions, getPrimitiveType, getRawType, getRawTypeSupplier, getRequirements, hasCombinedArguments, includeSuggestions, isListed, isOptional, parseArgument, 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<T>	executes(CommandExecutionInfo executor, ExecutorType... types)	Adds an executor to the current command builder
default Argument<T>	executes(CommandExecutor executor, ExecutorType... types)	Adds an executor to the current command builder
default Argument<T>	executes(ResultingCommandExecutionInfo executor, ExecutorType... types)	Adds an executor to the current command builder
default Argument<T>	executes(ResultingCommandExecutor executor, ExecutorType... types)	Adds an executor to the current command builder
default Argument<T>	executesCommandBlock(CommandBlockCommandExecutor executor)	Adds an executor to the current command builder
default Argument<T>	executesCommandBlock(CommandBlockExecutionInfo info)	Adds an executor to the current command builder
default Argument<T>	executesCommandBlock(CommandBlockResultingCommandExecutor executor)	Adds an executor to the current command builder
default Argument<T>	executesCommandBlock(CommandBlockResultingExecutionInfo info)	Adds an executor to the current command builder
default Argument<T>	executesConsole(ConsoleCommandExecutor executor)	Adds an executor to the current command builder
default Argument<T>	executesConsole(ConsoleExecutionInfo info)	Adds an executor to the current command builder
default Argument<T>	executesConsole(ConsoleResultingCommandExecutor executor)	Adds an executor to the current command builder
default Argument<T>	executesConsole(ConsoleResultingExecutionInfo info)	Adds an executor to the current command builder
default Argument<T>	executesEntity(EntityCommandExecutor executor)	Adds an executor to the current command builder
default Argument<T>	executesEntity(EntityExecutionInfo info)	Adds an executor to the current command builder
default Argument<T>	executesEntity(EntityResultingCommandExecutor executor)	Adds an executor to the current command builder
default Argument<T>	executesEntity(EntityResultingExecutionInfo info)	Adds an executor to the current command builder
default Argument<T>	executesFeedbackForwarding(FeedbackForwardingCommandExecutor executor)	Adds an executor to the current command builder
default Argument<T>	executesFeedbackForwarding(FeedbackForwardingExecutionInfo info)	Adds an executor to the current command builder
default Argument<T>	executesFeedbackForwarding(FeedbackForwardingResultingCommandExecutor executor)	Adds an executor to the current command builder
default Argument<T>	executesFeedbackForwarding(FeedbackForwardingResultingExecutionInfo info)	Adds an executor to the current command builder
default Argument<T>	executesNative(NativeCommandExecutor executor)	Adds an executor to the current command builder
default Argument<T>	executesNative(NativeExecutionInfo info)	Adds an executor to the current command builder
default Argument<T>	executesNative(NativeResultingCommandExecutor executor)	Adds an executor to the current command builder
default Argument<T>	executesNative(NativeResultingExecutionInfo info)	Adds an executor to the current command builder
default Argument<T>	executesPlayer(PlayerCommandExecutor executor)	Adds an executor to the current command builder
default Argument<T>	executesPlayer(PlayerExecutionInfo info)	Adds an executor to the current command builder
default Argument<T>	executesPlayer(PlayerResultingCommandExecutor executor)	Adds an executor to the current command builder
default Argument<T>	executesPlayer(PlayerResultingExecutionInfo info)	Adds an executor to the current command builder
default Argument<T>	executesProxy(ProxyCommandExecutor executor)	Adds an executor to the current command builder
default Argument<T>	executesProxy(ProxyExecutionInfo info)	Adds an executor to the current command builder
default Argument<T>	executesProxy(ProxyResultingCommandExecutor executor)	Adds an executor to the current command builder
default Argument<T>	executesProxy(ProxyResultingExecutionInfo info)	Adds an executor to the current command builder
default Argument<T>	executesRemoteConsole(RemoteConsoleCommandExecutor executor)	Adds an executor to the current command builder
default Argument<T>	executesRemoteConsole(RemoteConsoleExecutionInfo info)	Adds an executor to the current command builder
default Argument<T>	executesRemoteConsole(RemoteConsoleResultingCommandExecutor executor)	Adds an executor to the current command builder
default Argument<T>	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

Argument

protected Argument(String nodeName,
 Supplier<com.mojang.brigadier.arguments.ArgumentType<?>> rawType)

Constructs an argument with a given NMS/brigadier type.

Parameters:

nodeName - the name to assign to this argument node

rawType - the NMS or brigadier type to be used for this argument

Method Details

instance

public Argument<T> instance()

Specified by:

instance in interface ChainableBuilder<T>

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<T> clearExecutors()