fr.aumgn.bukkitutils.command.args

Class CommandArgsBase

java.lang.Object

fr.aumgn.bukkitutils.command.args.CommandArgsBase

Direct Known Subclasses:

CommandArgs

public class CommandArgsBase
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected CommandsMessages	messages

Constructor Summary

Constructors

Constructor and Description
CommandArgsBase(CommandsMessages messages, CommandArgsParser parser)

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	asList() Returns all arguments as a list.
List<String>	asList(int index) Returns all arguments starting from index as a list.
List<String>	asList(int index, int endIndex) Returns all arguments from index to endIndex as a list.
Iterable<Character>	flags() Returns an iterable over all boolean flags.
String	get(char flag) Get the given argument flag value.
<T extends Enum<T>> EnumArg<T>	get(char flag, Class<T> enumClass) Get the EnumArg value corresponding to the given enum class for the given flag.
<T extends CommandArg<?>> T	get(char flag, CommandArgFactory<T> factory) Get the CommandArg corresponding to the given factory for the given argument flag.
String	get(char flag, String def) Get the given argument flag value or the default if omitted.
String	get(int index) Get the argument at the given position.
<T extends Enum<T>> EnumArg<T>	get(int index, Class<T> enumClass) Get the EnumArg value corresponding to the given enum class for the given index.
<T extends CommandArg<?>> T	get(int index, CommandArgFactory<T> factory) Get the CommandArg corresponding to the given factory for the given index.
String	get(int index, int rawEndIndex) Get the string containing all arguments from index to endIndex separated by a whitespace.
String	get(int index, int endIndex, String def) Get the string containing all arguments from index to endIndex separated by a whitespace or the given default.
String	get(int index, String def) Get the argument at the given position or the default if argument is omitted.
<T extends Enum<T>> ListArg<T,EnumArg<T>>	getList(char flag, Class<T> klass) Get the ListArg wrapping the EnumArg corresponding to the given enum class for the given flag.
<T extends Enum<T>> ListArg<T,EnumArg<T>>	getList(char flag, Class<T> klass, String separator) Get the ListArg wrapping the EnumArg corresponding to the given enum class for the given flag using the given separator.
<V,T extends CommandArg<V>> ListArg<V,T>	getList(char flag, CommandArgFactory<T> factory) Get the ListArg wrapping the CommandArg corresponding to the given factory for the given flag.
<V,T extends CommandArg<V>> ListArg<V,T>	getList(char flag, CommandArgFactory<T> factory, String separator) Get the ListArg wrapping the CommandArg corresponding to the given factory for the given flag using the given separator.
<T extends Enum<T>> ListArg<T,EnumArg<T>>	getList(int index, Class<T> klass) Get the ListArg wrapping the EnumArg corresponding to the given enum class for the given index.
<T extends Enum<T>> ListArg<T,EnumArg<T>>	getList(int index, Class<T> klass, String separator) Get the ListArg wrapping the EnumArg corresponding to the given enum class for the given index using the given separator.
<V,T extends CommandArg<V>> ListArg<V,T>	getList(int index, CommandArgFactory<T> factory) Get the ListArg wrapping the CommandArg corresponding to the given factory for the given index.
<V,T extends CommandArg<V>> ListArg<V,T>	getList(int index, CommandArgFactory<T> factory, String separator) Get the ListArg wrapping the CommandArg corresponding to the given factory for the given index using the given separator.
protected String	getOrNull(char flag)
protected String	getOrNull(int index)
boolean	hasArgFlag(char character) Checks if the commands has the given argument flag.
boolean	hasFlag(char character) Checks if the commands has the given boolean flag.
boolean	hasFlags() Checks if the command has flags either boolean flag or argument flag.
Iterator<String>	iterator() Iterator over all arguments (does not include argument flags).
int	length() Returns the number of argument.

Methods inherited from class java.lang.Object

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

Field Detail

messages

protected final CommandsMessages messages

Constructor Detail

CommandArgsBase

public CommandArgsBase(CommandsMessages messages,
               CommandArgsParser parser)

Method Detail

hasFlags

public boolean hasFlags()

Checks if the command has flags either boolean flag or argument flag.

hasFlag

public boolean hasFlag(char character)

Checks if the commands has the given boolean flag.

hasArgFlag

public boolean hasArgFlag(char character)

Checks if the commands has the given argument flag.

flags

public Iterable<Character> flags()

Returns an iterable over all boolean flags.

length

public int length()

Returns the number of argument.

get

public String get(int index)

Get the argument at the given position.

get

public String get(int index,
         String def)

Get the argument at the given position or the default if argument is omitted.

get

public String get(char flag)

Get the given argument flag value.

get

public String get(char flag,
         String def)

Get the given argument flag value or the default if omitted.

getOrNull

protected String getOrNull(int index)

getOrNull

protected String getOrNull(char flag)

get

public <T extends CommandArg<?>> T get(int index,
                              CommandArgFactory<T> factory)

Get the CommandArg corresponding to the given factory for the given index.

get

public <T extends CommandArg<?>> T get(char flag,
                              CommandArgFactory<T> factory)

Get the CommandArg corresponding to the given factory for the given argument flag.

get

public <T extends Enum<T>> EnumArg<T> get(int index,
                                 Class<T> enumClass)

Get the EnumArg value corresponding to the given enum class for the given index.

get

public <T extends Enum<T>> EnumArg<T> get(char flag,
                                 Class<T> enumClass)

Get the EnumArg value corresponding to the given enum class for the given flag.

getList

public <V,T extends CommandArg<V>> ListArg<V,T> getList(int index,
                                               CommandArgFactory<T> factory)

Get the ListArg wrapping the CommandArg corresponding to the given factory for the given index.

getList

public <V,T extends CommandArg<V>> ListArg<V,T> getList(int index,
                                               CommandArgFactory<T> factory,
                                               String separator)

Get the ListArg wrapping the CommandArg corresponding to the given factory for the given index using the given separator.

getList

public <V,T extends CommandArg<V>> ListArg<V,T> getList(char flag,
                                               CommandArgFactory<T> factory)

Get the ListArg wrapping the CommandArg corresponding to the given factory for the given flag.

getList

public <V,T extends CommandArg<V>> ListArg<V,T> getList(char flag,
                                               CommandArgFactory<T> factory,
                                               String separator)

Get the ListArg wrapping the CommandArg corresponding to the given factory for the given flag using the given separator.

getList

public <T extends Enum<T>> ListArg<T,EnumArg<T>> getList(int index,
                                                Class<T> klass)

Get the ListArg wrapping the EnumArg corresponding to the given enum class for the given index.

getList

public <T extends Enum<T>> ListArg<T,EnumArg<T>> getList(int index,
                                                Class<T> klass,
                                                String separator)

Get the ListArg wrapping the EnumArg corresponding to the given enum class for the given index using the given separator.

getList

public <T extends Enum<T>> ListArg<T,EnumArg<T>> getList(char flag,
                                                Class<T> klass)

Get the ListArg wrapping the EnumArg corresponding to the given enum class for the given flag.

getList

public <T extends Enum<T>> ListArg<T,EnumArg<T>> getList(char flag,
                                                Class<T> klass,
                                                String separator)

Get the ListArg wrapping the EnumArg corresponding to the given enum class for the given flag using the given separator.

get

public String get(int index,
         int rawEndIndex)

Get the string containing all arguments from index to endIndex separated by a whitespace.

get

public String get(int index,
         int endIndex,
         String def)

Get the string containing all arguments from index to endIndex separated by a whitespace or the given default.

asList

public List<String> asList()

Returns all arguments as a list.

asList

public List<String> asList(int index)

Returns all arguments starting from index as a list.

asList

public List<String> asList(int index,
                  int endIndex)

Returns all arguments from index to endIndex as a list.

iterator

public Iterator<String> iterator()

Iterator over all arguments (does not include argument flags).