com.sk89q.intake.argument

Interface CommandArgs

public interface CommandArgs

Provides access to provided user arguments as a stack.

Method Summary

Modifier and Type	Method and Description
Map<Character,String>	getFlags() Get a map of defined flags.
Namespace	getNamespace() Get the map of provided values.
boolean	hasNext() Tests whether there are additional arguments that can be read.
void	markConsumed() Move the pointer to the end so that there are no unconsumed arguments.
String	next() Read the next argument.
boolean	nextBoolean() Read the next argument as a boolean.
byte	nextByte() Read the next argument as a byte.
double	nextDouble() Read the next argument as a double.
float	nextFloat() Read the next argument as a float.
int	nextInt() Read the next argument as an integer.
short	nextShort() Read the next argument as a short.
String	peek() Return the next argument without moving the pointer.
int	position() Get the current position of the pointer in the stack of arguments.
int	size() Return the number of arguments in total.

Method Detail

hasNext

boolean hasNext()

Tests whether there are additional arguments that can be read.

Returns:

Whether there are additional arguments

next

String next()
     throws MissingArgumentException

Read the next argument.

Returns:

The next argument

Throws:

MissingArgumentException - Thrown if there are no remaining arguments

nextInt

int nextInt()
     throws MissingArgumentException,
            ArgumentParseException

Read the next argument as an integer.

Returns:

The next argument as an integer

Throws:

MissingArgumentException - Thrown if there are no remaining arguments

ArgumentParseException - Thrown if the next argument could not be parsed to an integer

nextShort

short nextShort()
         throws MissingArgumentException,
                ArgumentParseException

Read the next argument as a short.

Returns:

The next argument as an short

Throws:

MissingArgumentException - Thrown if there are no remaining arguments

ArgumentParseException - Thrown if the next argument could not be parsed to an short

nextByte

byte nextByte()
       throws MissingArgumentException,
              ArgumentParseException

Read the next argument as a byte.

Returns:

The next argument as an byte

Throws:

MissingArgumentException - Thrown if there are no remaining arguments

ArgumentParseException - Thrown if the next argument could not be parsed to an byte

nextDouble

double nextDouble()
           throws MissingArgumentException,
                  ArgumentParseException

Read the next argument as a double.

Returns:

The next argument as an double

Throws:

MissingArgumentException - Thrown if there are no remaining arguments

ArgumentParseException - Thrown if the next argument could not be parsed to an double

nextFloat

float nextFloat()
         throws MissingArgumentException,
                ArgumentParseException

Read the next argument as a float.

Returns:

The next argument as an float

Throws:

MissingArgumentException - Thrown if there are no remaining arguments

ArgumentParseException - Thrown if the next argument could not be parsed to an float

nextBoolean

boolean nextBoolean()
             throws MissingArgumentException,
                    ArgumentParseException

Read the next argument as a boolean.

Returns:

The next argument as an boolean

Throws:

MissingArgumentException - Thrown if there are no remaining arguments

ArgumentParseException - Thrown if the next argument could not be parsed to an boolean

peek

String peek()
     throws MissingArgumentException

Return the next argument without moving the pointer.

Returns:

The next argument

Throws:

MissingArgumentException - Thrown if there are no remaining arguments

position

int position()

Get the current position of the pointer in the stack of arguments.

The current position indicates the value that will be returned by the next call to next() and it starts at 0. If the current position is equal to size(), then there are no more arguments available.

Returns:

The current position, starting from 0

size

int size()

Return the number of arguments in total.

Returns:

The number of arguments

markConsumed

void markConsumed()

Move the pointer to the end so that there are no unconsumed arguments.

getFlags

Map<Character,String> getFlags()

Get a map of defined flags.

Keys are the flag (case-sensitive) and values are the values for the flag. For boolean flags, the value should be the string "true". Flags are commonly defined by the player by using syntax similar to -X value.

Returns:

The map of flags

getNamespace

Namespace getNamespace()

Get the map of provided values.

The keys and values in a Namespace are defined before command parsing has begun and they can be used by commands or Provider to get session-related values.

Returns:

The map of provided values