Package dev.jorel.commandapi.arguments

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, AdventureChatColorArgument, AngleArgument, AxisArgument, BiomeArgument, BiomeArgument.NamespacedKey, BooleanArgument, ChatColorArgument, DoubleArgument, EnchantmentArgument, EntityTypeArgument, FloatArgument, FloatRangeArgument, FunctionArgument, GreedyStringArgument, IntegerArgument, IntegerRangeArgument, ItemStackArgument, Location2DArgument, LocationArgument, LongArgument, LootTableArgument, MathOperationArgument, NamespacedKeyArgument, NBTCompoundArgument, ObjectiveArgument, OfflinePlayerArgument, ParticleArgument, PlayerArgument, PotionEffectArgument, PotionEffectArgument.NamespacedKey, RecipeArgument, 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, 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 dev.jorel.commandapi.arguments.Argument

instance

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

combineWith, copyPermissionsAndRequirements, getArgumentPermission, getArgumentType, getCombinedArguments, getEntityNames, getHelpString, getIncludedSuggestions, getNodeName, getOverriddenSuggestions, getPrimitiveType, getRawType, getRequirements, hasCombinedArguments, includeSuggestions, isListed, isOptional, parseArgument, 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

Methods inherited from interface dev.jorel.commandapi.arguments.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,
 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()