com.moderocky.mask.command

Class ArgInteger

java.lang.Object

com.moderocky.mask.command.ArgInteger

All Implemented Interfaces:

Argument<Integer>

public class ArgInteger
extends Object
implements Argument<Integer>

Version:

1.0.0

Author:

Moderocky

Constructor Summary

Constructors

Constructor and Description
ArgInteger()

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.
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.
@NotNull Integer	serialise(String string) This should convert the player's input to a valid object.
ArgInteger	setLabel(@NotNull String label) Ideally, this should set a field that will then be returned by Argument.getName().
ArgInteger	setRequired(boolean boo) Ideally, this should set a field that will then be returned by Argument.isRequired().

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.moderocky.mask.command.Argument

getType

Constructor Detail

ArgInteger

public ArgInteger()

Method Detail

serialise

@NotNull
public @NotNull Integer serialise(String string)

Description copied from interface: Argument

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

Specified by:

serialise in interface Argument<Integer>

Parameters:

string - The passed argument.

Returns:

The serialised object

matches

public boolean matches(String string)

Description copied from interface: Argument

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.

Specified by:

matches in interface Argument<Integer>

Parameters:

string - The player's input argument.

Returns:

Boo

getName

@NotNull
public @NotNull String getName()

Description copied from interface: Argument

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

Specified by:

getName in interface Argument<Integer>

Returns:

The argument name

getCompletions

@Nullable
public @Nullable List<String> getCompletions()

Description copied from interface: Argument

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

Specified by:

getCompletions in interface Argument<Integer>

Returns:

A list of completions

isPlural

public boolean isPlural()

Description copied from interface: Argument

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]"

Specified by:

isPlural in interface Argument<Integer>

Returns:

Whether this accepts plurals, true or false

isRequired

public boolean isRequired()

Description copied from interface: Argument

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

Specified by:

isRequired in interface Argument<Integer>

Returns:

Boo

setRequired

public ArgInteger setRequired(boolean boo)

Description copied from interface: Argument

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

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

Specified by:

setRequired in interface Argument<Integer>

Parameters:

boo - True/false.

Returns:

The argument, allowing for method chaining

setLabel

public ArgInteger setLabel(@NotNull
                           @NotNull String label)

Description copied from interface: Argument

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

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

Specified by:

setLabel in interface Argument<Integer>

Parameters:

label - The label to be put [here];

Returns:

The argument, allowing for method chaining