fr.aumgn.bukkitutils.command.arg.basic

Class ListArg<V,T extends CommandArg<V>>

java.lang.Object

fr.aumgn.bukkitutils.command.arg.basic.ListArg<V,T>

All Implemented Interfaces:

CommandArg<List<V>>, MatchingArg<V>, SenderArg<List<V>>, SenderMatchingArg<V>, Iterable<T>

public class ListArg<V,T extends CommandArg<V>>
extends Object
implements CommandArg<List<V>>, MatchingArg<V>, SenderArg<List<V>>, SenderMatchingArg<V>, Iterable<T>

Constructor Summary

Constructors

Constructor and Description
ListArg(String separator, CommandArgFactory<T> factory, String string)

Method Summary

Methods

Modifier and Type	Method and Description
Iterator<T>	iterator()
List<V>	match() Returns all values which match the argument.
List<V>	matchOr(CommandSender sender) Returns all values which match the argument or the given CommandSender if argument is omitted.
List<V>	matchOr(List<V> def) Returns all values which match the argument or the given default list if the argument is omitted.
List<V>	matchOr(V def) Returns all values which match the argument or a list containing the given default if argument is omitted.
List<V>	matchWithPermOr(String permission, CommandSender sender) Same as SenderMatchingArg.matchOr(CommandSender) but also check the given permission if the argument is specified.
List<V>	value() Returns the parsed value.
List<V>	valueOr(CommandSender sender) Returns the parsed value or compute it from the given CommandSender if argument is omitted.
List<V>	valueOr(List<V> def) Returns the parsed value or the given default if the argument is omitted.
List<V>	valueOrSingleton(V def)
List<V>	valueWithPermOr(String permission, CommandSender sender) Same as SenderArg.valueOr(CommandSender) but also check the given permission if the argument is specified.

Methods inherited from class java.lang.Object

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

Constructor Detail

ListArg

public ListArg(String separator,
       CommandArgFactory<T> factory,
       String string)

Method Detail

value

public List<V> value()

Description copied from interface: CommandArg

Returns the parsed value. This must not be called if the corresponding argument is optional or bad things may happen.

Specified by:

value in interface CommandArg<List<V>>

valueOrSingleton

public List<V> valueOrSingleton(V def)

valueOr

public List<V> valueOr(List<V> def)

Description copied from interface: CommandArg

Returns the parsed value or the given default if the argument is omitted.

Specified by:

valueOr in interface CommandArg<List<V>>

valueOr

public List<V> valueOr(CommandSender sender)

Returns the parsed value or compute it from the given CommandSender if argument is omitted. Note that the CommandArg type argument of this ListArg must implement SenderArg or this will throws an UnsupportedOperationException.

Specified by:

valueOr in interface SenderArg<List<V>>

Throws:

UnsupportedOperationException

valueWithPermOr

public List<V> valueWithPermOr(String permission,
                      CommandSender sender)

Same as SenderArg.valueOr(CommandSender) but also check the given permission if the argument is specified. Note that the CommandArg type argument of this ListArg must implement SenderArg or this will throws an UnsupportedOperationException.

Specified by:

valueWithPermOr in interface SenderArg<List<V>>

Throws:

UnsupportedOperationException

match

public List<V> match()

Returns all values which match the argument. This should not be called is argument is optional. Note that the CommandArg type argument of this ListArg must implement MatchingArg or this will throws an UnsupportedOperationException.

Specified by:

match in interface MatchingArg<V>

Throws:

UnsupportedOperationException

matchOr

public List<V> matchOr(V def)

Returns all values which match the argument or a list containing the given default if argument is omitted. Note that the CommandArg type argument of this ListArg must implement MatchingArg or this will throws an UnsupportedOperationException.

Specified by:

matchOr in interface MatchingArg<V>

Throws:

UnsupportedOperationException

matchOr

public List<V> matchOr(List<V> def)

Returns all values which match the argument or the given default list if the argument is omitted. Note that the CommandArg type argument of this ListArg must implement MatchingArg or this will throws an UnsupportedOperationException.

Specified by:

matchOr in interface MatchingArg<V>

Throws:

UnsupportedOperationException

matchOr

public List<V> matchOr(CommandSender sender)

Returns all values which match the argument or the given CommandSender if argument is omitted. Note that the CommandArg type argument of this ListArg must implement SenderMatchingArg or this will throws an UnsupportedOperationException.

Specified by:

matchOr in interface SenderMatchingArg<V>

Throws:

UnsupportedOperationException

matchWithPermOr

public List<V> matchWithPermOr(String permission,
                      CommandSender sender)

Same as SenderMatchingArg.matchOr(CommandSender) but also check the given permission if the argument is specified. Note that the CommandArg type argument of this ListArg must implement SenderMatchingArg or this will throws an UnsupportedOperationException.

Specified by:

matchWithPermOr in interface SenderMatchingArg<V>

Throws:

UnsupportedOperationException

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T extends CommandArg<V>>