Class SafeOverrideableArgument<T,S>

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>

dev.jorel.commandapi.arguments.SafeOverrideableArgument<T,S>

Type Parameters:

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

S - A custom type which is represented by this argument. For example, a StringArgument will have a custom type String

All Implemented Interfaces:

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

Direct Known Subclasses:

AdvancementArgument, AngleArgument, AxisArgument, BiomeArgument, BiomeArgument.NamespacedKey, BooleanArgument, DoubleArgument, DoubleRangeArgument, EnchantmentArgument, EntityTypeArgument, FloatArgument, FunctionArgument, GreedyStringArgument, IntegerArgument, IntegerRangeArgument, ItemStackArgument, Location2DArgument, LocationArgument, LongArgument, LootTableArgument, MathOperationArgument, NamespacedKeyArgument, NBTCompoundArgument, ObjectiveArgument, ParticleArgument, PotionEffectArgument, PotionEffectArgument.NamespacedKey, RotationArgument, ScoreboardSlotArgument, SoundArgument, SoundArgument.NamespacedKey, TeamArgument, TimeArgument, UUIDArgument, WorldArgument

public abstract class SafeOverrideableArgument<T,S>
extends Argument<T>
implements SafeOverrideable<T, S, Argument<T>, Argument<?>, org.bukkit.command.CommandSender>

An interface declaring methods required to override argument suggestions

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	SafeOverrideableArgument(String nodeName, Supplier<com.mojang.brigadier.arguments.ArgumentType<?>> rawType, Function<S,String> mapper)	Instantiates this argument and assigns the mapper to the provided mapper

Method Summary

Modifier and Type	Method	Description
Argument<T>	clearExecutors()
static <S> Function<S,String>	fromKey(Function<S, org.bukkit.NamespacedKey> mapper)	Composes a S to a NamespacedKey mapping function to convert S to a String
CommandAPIExecutor<org.bukkit.command.CommandSender, AbstractCommandSender<? extends org.bukkit.command.CommandSender>>	getExecutor()
Function<S,String>	getMapper()
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<T>	instance()

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

Methods inherited from interface SafeOverrideable

includeSafeSuggestions, includeSuggestions, replaceSafeSuggestions, replaceSuggestions

Field Details

executor

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

Constructor Details

SafeOverrideableArgument

protected SafeOverrideableArgument(String nodeName,
 Supplier<com.mojang.brigadier.arguments.ArgumentType<?>> rawType,
 Function<S,String> mapper)

Instantiates this argument and assigns the mapper to the provided mapper

Parameters:

nodeName - the node name of this argument

rawType - the NMS raw argument type of this argument

mapper - the mapping function that maps this argument type to a string for suggestions

Method Details

getMapper

public Function<S,String> getMapper()

Specified by:

getMapper in interface SafeOverrideable<T, S, Argument<T>, Argument<?>, org.bukkit.command.CommandSender>

fromKey

public static <S> Function<S,String> fromKey(Function<S, org.bukkit.NamespacedKey> mapper)

Composes a S to a NamespacedKey mapping function to convert S to a String

Parameters:

mapper - the mapping function from S to NamespacedKey

Returns:

a composed function that converts S to String

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