org.spongepowered.api.text.selector

Interface Argument<T>

Type Parameters:

T - The type of the value

All Known Subinterfaces:

Argument.Invertible<T>

public interface Argument<T>

Represents the argument of a selector. An Argument is one or more key-to-value mappings (key=value) with the key represented by an ArgumentType.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Argument.Invertible<T> Represents an Argument which can be inverted to select all targets not matching the filter.

Method Summary

Modifier and Type	Method and Description
static <T> Argument.Invertible<T>	create(ArgumentType.Invertible<T> type, T value, boolean inverted) Creates a new Argument.Invertible using the specified type and value.
static <T> Argument<T>	create(ArgumentType<T> type, T value) Creates a new Argument using the specified type and value.
static <T,V> Set<Argument<T>>	createSet(ArgumentHolder<? extends ArgumentType<T>> type, V value) Creates a new set of Arguments using the specified type and value.
ArgumentType<T>	getType() Returns the type of this Argument.
T	getValue() Returns the value of this Argument.
static Argument<?>	parse(String argument) Parses an Argument from the given argument string.
String	toPlain() Converts this Argument to a valid argument string.

Method Detail

create

static <T> Argument<T> create(ArgumentType<T> type,
                              T value)

Creates a new Argument using the specified type and value.

If the type is invertible, the Argument will not be inverted.

Type Parameters:

T - The type of the argument value

Parameters:

type - The type of the argument

value - The value of the argument

Returns:

The created argument

create

static <T> Argument.Invertible<T> create(ArgumentType.Invertible<T> type,
                                         T value,
                                         boolean inverted)

Creates a new Argument.Invertible using the specified type and value. The created Argument will be inverted based on the given parameter.

Type Parameters:

T - The type of the argument value

Parameters:

type - The type of the invertible argument

value - The value of the invertible argument

inverted - true if the argument should be inverted

Returns:

The created invertible argument

createSet

static <T,V> Set<Argument<T>> createSet(ArgumentHolder<? extends ArgumentType<T>> type,
                                        V value)

Creates a new set of Arguments using the specified type and value.

Type Parameters:

T - The type of the arguments' joined value

V - The type of the arguments' sub-values

Parameters:

type - The type of the arguments

value - The value of the arguments

Returns:

The created argument

parse

static Argument<?> parse(String argument)
                  throws IllegalArgumentException

Parses an Argument from the given argument string.

In Vanilla, it should be formatted like key=value.

Parameters:

argument - The argument string

Returns:

The parsed argument

Throws:

IllegalArgumentException - If the argument couldn't be parsed (e.g. due to invalid format)

getType

ArgumentType<T> getType()

Returns the type of this Argument.

Returns:

The type of this argument

getValue

T getValue()

Returns the value of this Argument.

Returns:

The value of this argument

toPlain

String toPlain()

Converts this Argument to a valid argument string.

Returns:

The plain argument string