com.moderocky.mask.command

Interface Argument<X>

Type Parameters:

X - The return type post-serialisation.

All Known Implementing Classes:

ArgBukkitPlugin, ArgBungeePlayer, ArgBungeePlugin, ArgBungeeServer, ArgInteger, ArgNumber, ArgOfflinePlayer, ArgPlayer, ArgString

public interface Argument<X>

Version:

2.0.0

This class manages arguments for the . The key aspects are to check if an input is valid, convert it to a workable type and to provide completions for guidance.

Author:

Moderocky

Method Summary

Modifier and Type	Method and Description
@Nullable List<String>	getCompletions() A list of completions for this argument type.
@NotNull String	getName() This is what your argument shows up as in a command.
default Class<X>	getType()
boolean	isPlural() Used by the system to determine if this argument accepts multiple inputs.
boolean	isRequired() Used by the system when testing the command.
boolean	matches(String string) This is your matcher, to check if the player's input is valid.
X	serialise(String string) This should convert the player's input to a valid object.
Argument<X>	setLabel(@NotNull String name) Ideally, this should set a field that will then be returned by getName().
Argument<X>	setRequired(boolean boo) Ideally, this should set a field that will then be returned by isRequired().

Method Detail

serialise

@NotNull
X serialise(String string)

This should convert the player's input to a valid object. This should never be null (?!) as matches(String) will be called first. Generally, throw an exception if something goes wrong.

Parameters:

string - The passed argument.

Returns:

The serialised object

matches

boolean matches(String string)

This is your matcher, to check if the player's input is valid. If it isn't, the action won't pass.

For example: a material-accepting argument checks if the string matches a Material enum and, if so, if the enum is a block. In this case, "grass_block" would pass (Material.GRASS_BLOCK but "blob" and "diamond_sword" wouldn't as they are not materials/blocks respectively.

This should be a catch-all. If there is any chance of it not being valid, this should FAIL.

Parameters:

string - The player's input argument.

Returns:

Boo

getType

default Class<X> getType()

getName

@NotNull
@NotNull String getName()

This is what your argument shows up as in a command.

Good examples: "block", "material", "entity", "player"

Bad examples: "string" (one exists already), "<test>" (the brackets are added later), "something" (vague and unhelpful), "blocks like stone" (should be one word), "verylongcommandargument" (too long).

Returns:

The argument name

getCompletions

@Nullable
@Nullable List<String> getCompletions()

A list of completions for this argument type. This helps the player to understand what is required.

Returns:

A list of completions

isPlural

boolean isPlural()

Used by the system to determine if this argument accepts multiple inputs. These should almost always be separated by commas.

The command handler will automatically handle plural suggestions using comma separation.

Typical plurals: "stone,grass_block,dirt", "stone_stairs[facing=north],oak_log,stone_slab[half=top]"

Returns:

Whether this accepts plurals, true or false

isRequired

boolean isRequired()

Used by the system when testing the command. This should ALWAYS default to true.

Returns:

Boo

setRequired

Argument<X> setRequired(boolean boo)

Ideally, this should set a field that will then be returned by isRequired(). This should ALWAYS default to true.

Note: You may want to change the Argument returned to be of your implementing class type.

Parameters:

boo - True/false.

Returns:

The argument, allowing for method chaining

setLabel

Argument<X> setLabel(@NotNull
                     @NotNull String name)

Ideally, this should set a field that will then be returned by getName().

Note: You may want to change the Argument returned to be of your implementing class type.

Parameters:

name - The label to be put [here];

Returns:

The argument, allowing for method chaining