com.codelanx.codelanxlib.command

Class TabInfo

java.lang.Object

com.codelanx.codelanxlib.command.TabInfo

public class TabInfo
extends Object

Utility class for mapping command arguments to simplify basic uses of CommandNode.tabComplete(CommandSender, String...)

Since:

0.1.0

Version:

0.1.0

Author:

1Rogue

Field Summary

Fields

Modifier and Type	Field and Description
static List<String>	BLANK_TAB_COMPLETE Represents a blank List for returning no input from CommandNode.tabComplete(CommandSender, String...)

Constructor Summary

Constructors

Constructor and Description
TabInfo()

Method Summary

Modifier and Type	Method and Description
List<String>	apply(CommandSender sender, String... args) Applies this TabInfo to a series of command arguments.
List<String>	apply(String... args) Returns this.apply(null, args) Applies this TabInfo to a series of command arguments.
void	map(int argCount, BiFunction<CommandSender,String,? extends List<String>> defaults) Maps an argument count to a BiFunction that accepts the CommandSender who tabbed, the relevant argument being parsed, or null if there is no argument to parse, and returns a List<String> of the results.
void	map(int argCount, Function<String,? extends List<String>> defaults) Maps an argument count to a Function that accepts the relevant argument being parsed, or null if there is no argument to parse, and returns a List<String> of the results
void	map(int argCount, List<String> defaults) Maps an argument count to a specific list of default argument values.
void	map(int argCount, String... defaults) Maps an argument count to a series of default argument values.
void	map(int argCount, Supplier<? extends List<String>> defaults) Maps an argument count to a Supplier for a List<String>
static Supplier<List<String>>	onlinePlayers() Returns a Supplier which will return a string List of online players
static Supplier<List<String>>	onlinePlayers(Predicate<? super Player> filter) Returns a Supplier which will return a string List of online players, filtered by the given predicate.

Methods inherited from class java.lang.Object

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

Field Detail

BLANK_TAB_COMPLETE

public static final List<String> BLANK_TAB_COMPLETE

Represents a blank List for returning no input from CommandNode.tabComplete(CommandSender, String...)

Constructor Detail

TabInfo

public TabInfo()

Method Detail

map

public void map(int argCount,
                String... defaults)

Maps an argument count to a series of default argument values. Note that your first arguments (the ones which immediately proceed the CommandNode itself) should be mapped at argCount 0

Parameters:

argCount - The number of arguments for these defaults

defaults - The defaults to set

Since:

0.1.0

map

public void map(int argCount,
                List<String> defaults)

Maps an argument count to a specific list of default argument values. Note that your first arguments (the ones which immediately proceed the CommandNode itself) should be mapped at argCount 0

Parameters:

argCount - The number of arguments for these defaults

defaults - The defaults to set

Since:

0.1.0

map

public void map(int argCount,
                Supplier<? extends List<String>> defaults)

Maps an argument count to a Supplier for a List<String>

Parameters:

argCount - The number of arguments for these defaults

defaults - A Supplier that returns a List of strings

Since:

0.1.0

map

public void map(int argCount,
                Function<String,? extends List<String>> defaults)

Maps an argument count to a Function that accepts the relevant argument being parsed, or null if there is no argument to parse, and returns a List<String> of the results

Parameters:

argCount - The number of arguments for these defaults

defaults - A Function which accepts a possibly null argument that is being parsed, and returns a List of possible strings for arguments

Since:

0.1.0

map

public void map(int argCount,
                BiFunction<CommandSender,String,? extends List<String>> defaults)

Maps an argument count to a BiFunction that accepts the CommandSender who tabbed, the relevant argument being parsed, or null if there is no argument to parse, and returns a List<String> of the results.

Parameters:

argCount - The number of arguments for these defaults

defaults - A BiFunction that accepts the sender who tabbed, the relevant argument being tabbed (or null), and returns a List of possible string arguments to fill with

Since:

0.1.0

apply

public List<String> apply(String... args)

Returns this.apply(null, args)

Applies this TabInfo to a series of command arguments. If the final argument is incomplete, then any default arguments which do not start with the specified incomplete argument will be removed from the possible results

Parameters:

args - The arguments being tested

Returns:

The possible arguments that could be used

Since:

0.1.0

See Also:

apply(CommandSender, String...)

apply

public List<String> apply(CommandSender sender,
                          String... args)

Applies this TabInfo to a series of command arguments. If the final argument is incomplete, then any default arguments which do not start with the specified incomplete argument will be removed from the possible results

Parameters:

sender - The CommandSender who is tabbing

args - The arguments being tested

Returns:

The possible arguments that could be used

Since:

0.1.0

onlinePlayers

public static Supplier<List<String>> onlinePlayers()

Returns a Supplier which will return a string List of online players

Returns:

A Supplier for a List of online player's names

Since:

0.1.0

onlinePlayers

public static Supplier<List<String>> onlinePlayers(Predicate<? super Player> filter)

Returns a Supplier which will return a string List of online players, filtered by the given predicate. This Supplier will contain only the elements which return true from the Predicate

Parameters:

filter - The Predicate to filter by

Returns:

A Supplier for a List of online player's names

Since:

0.1.0