com.sk89q.intake

Class OptionType

java.lang.Object

com.sk89q.intake.OptionType

public abstract class OptionType
extends Object

Defines the type of parameter, whether it is positional, a flag, optional, or required.

Method Summary

Modifier and Type	Method and Description
static OptionType	flag(Character flag) Get the non-value boolean flag type of parameter.
abstract Character	getFlag() Get the flag associated with this parameter.
abstract boolean	isOptional() Get whether this parameter is optional.
abstract boolean	isValueFlag() Return whether the flag is a value flag.
static OptionType	optionalPositional() Get the optional positional type of parameter.
static OptionType	positional() Get the required positional type of parameter.
abstract CommandArgs	transform(CommandArgs arguments) Create a new list of command arguments for the given arguments that is appropriate for this type of parameter.
static OptionType	valueFlag(Character flag) Get the value flag type of parameter.

Methods inherited from class java.lang.Object

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

Method Detail

getFlag

@Nullable
public abstract Character getFlag()

Get the flag associated with this parameter.

Returns:

the flag, or null if there is no flag associated

See Also:

isValueFlag()

isValueFlag

public abstract boolean isValueFlag()

Return whether the flag is a value flag.

Returns:

true if the flag is a value flag

See Also:

getFlag()

isOptional

public abstract boolean isOptional()

Get whether this parameter is optional.

Returns:

true if the parameter does not have to be specified

transform

public abstract CommandArgs transform(CommandArgs arguments)

Create a new list of command arguments for the given arguments that is appropriate for this type of parameter.

For example, if the type of parameter is a value flag, then the returned arguments object will only have the value flag's value as the argument.

Parameters:

arguments - The list of arguments

Returns:

The new list of arguments

positional

public static OptionType positional()

Get the required positional type of parameter.

Returns:

An option type

optionalPositional

public static OptionType optionalPositional()

Get the optional positional type of parameter.

Returns:

An option type

flag

public static OptionType flag(Character flag)

Get the non-value boolean flag type of parameter.

Returns:

An option type

valueFlag

public static OptionType valueFlag(Character flag)

Get the value flag type of parameter.

Returns:

An option type