com.sk89q.intake.parametric.argument

Interface ArgumentStack

All Known Implementing Classes:

ContextArgumentStack, StringArgumentStack

public interface ArgumentStack

Method Summary

Modifier and Type	Method and Description
CommandContext	getContext() Get the underlying context.
void	markConsumed() Set as completely consumed.
String	next() Get the next string, which may come from the stack or a value flag.
Boolean	nextBoolean() Get the next boolean, which may come from the stack or a value flag.
Double	nextDouble() Get the next double, which may come from the stack or a value flag.
Integer	nextInt() Get the next integer, which may come from the stack or a value flag.
String	remaining() Get all remaining string values, which will consume the rest of the stack.

Method Detail

next

String next()
     throws ParameterException

Get the next string, which may come from the stack or a value flag.

Returns:

the value

Throws:

ParameterException - on a parameter error

nextInt

Integer nextInt()
         throws ParameterException

Get the next integer, which may come from the stack or a value flag.

Returns:

the value

Throws:

ParameterException - on a parameter error

nextDouble

Double nextDouble()
           throws ParameterException

Get the next double, which may come from the stack or a value flag.

Returns:

the value

Throws:

ParameterException - on a parameter error

nextBoolean

Boolean nextBoolean()
             throws ParameterException

Get the next boolean, which may come from the stack or a value flag.

Returns:

the value

Throws:

ParameterException - on a parameter error

remaining

String remaining()
          throws ParameterException

Get all remaining string values, which will consume the rest of the stack.

Returns:

the value

Throws:

ParameterException - on a parameter error

markConsumed

void markConsumed()

Set as completely consumed.

getContext

CommandContext getContext()

Get the underlying context.

Returns:

the context