org.enginehub.piston

Interface CommandValue

public interface CommandValue

All values provided from the command line for a part. They can be converted to a type, if the appropriate converter is registered with the manager.

Method Summary

Modifier and Type	Method and Description
default <T> com.google.common.collect.ImmutableList<T>	asMultiple(java.lang.Class<T> key) Convert the string values using the converted registered under the given key.
<T> com.google.common.collect.ImmutableList<T>	asMultiple(Key<T> key) Convert the string values using the converted registered under the given key.
default <T> T	asSingle(java.lang.Class<T> key) Convert the string value using the converted registered under the given key.
default <T> T	asSingle(Key<T> key) Convert the string value using the converted registered under the given key.
default java.lang.String	asString() Get a single string value.
com.google.common.collect.ImmutableList<java.lang.String>	asStrings() Get all the string values.

Method Detail

asStrings

com.google.common.collect.ImmutableList<java.lang.String> asStrings()

Get all the string values.

asString

default java.lang.String asString()

Get a single string value. Throws if multiple values are present.

Throws:

java.lang.IllegalStateException - if not exactly one value is present

asMultiple

default <T> com.google.common.collect.ImmutableList<T> asMultiple(java.lang.Class<T> key)

Convert the string values using the converted registered under the given key.

Type Parameters:

T - the type of the values

Parameters:

key - the key for the converter

Returns:

the converted values

See Also:

asMultiple(Key)

asMultiple

<T> com.google.common.collect.ImmutableList<T> asMultiple(Key<T> key)

Convert the string values using the converted registered under the given key.

Type Parameters:

T - the type of the values

Parameters:

key - the key for the converter

Returns:

the converted values

asSingle

@Nullable
default <T> T asSingle(java.lang.Class<T> key)

Convert the string value using the converted registered under the given key. Throws if multiple values are present.

Type Parameters:

T - the type of the value

Parameters:

key - the key for the converter

Returns:

the converted value

Throws:

java.lang.IllegalStateException - if not exactly one value is present

See Also:

asString(), asSingle(Key)

asSingle

@Nullable
default <T> T asSingle(Key<T> key)

Convert the string value using the converted registered under the given key. Throws if multiple values are present.

Type Parameters:

T - the type of the value

Parameters:

key - the key for the converter

Returns:

the converted value

Throws:

java.lang.IllegalStateException - if not exactly one value is present

See Also:

asString()