com.sk89q.intake.parametric.argument

Class ContextArgumentStack

java.lang.Object

com.sk89q.intake.parametric.argument.ContextArgumentStack

All Implemented Interfaces:

ArgumentStack

public class ContextArgumentStack
extends Object
implements ArgumentStack

Makes an instance of a CommandContext into a stack of arguments that can be consumed.

See Also:

a user of this class

Constructor Summary

Constructors

Constructor and Description
ContextArgumentStack(CommandContext context) Create a new instance using the given context.

Method Summary

Modifier and Type	Method and Description
String	getConsumed() Return the arguments that were consumed between this point and that marked point.
CommandContext	getContext() Get the underlying context.
String	getUnconsumed() Get the unconsumed arguments left over, without touching the stack.
void	mark() Mark the current position of the stack.
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.
int	position() Return the current position.
String	remaining() Get all remaining string values, which will consume the rest of the stack.
String	reset() Reset to the previously mark()ed position of the stack, and return the arguments that were consumed between this point and that previous point.
boolean	wasConsumed() Return whether any arguments were consumed between the marked position and the current position.

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextArgumentStack

public ContextArgumentStack(CommandContext context)

Create a new instance using the given context.

Parameters:

context - the context

Method Detail

next

public String next()
            throws ParameterException

Description copied from interface: ArgumentStack

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

Specified by:

next in interface ArgumentStack

Returns:

the value

Throws:

ParameterException - on a parameter error

nextInt

public Integer nextInt()
                throws ParameterException

Description copied from interface: ArgumentStack

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

Specified by:

nextInt in interface ArgumentStack

Returns:

the value

Throws:

ParameterException - on a parameter error

nextDouble

public Double nextDouble()
                  throws ParameterException

Description copied from interface: ArgumentStack

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

Specified by:

nextDouble in interface ArgumentStack

Returns:

the value

Throws:

ParameterException - on a parameter error

nextBoolean

public Boolean nextBoolean()
                    throws ParameterException

Description copied from interface: ArgumentStack

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

Specified by:

nextBoolean in interface ArgumentStack

Returns:

the value

Throws:

ParameterException - on a parameter error

remaining

public String remaining()
                 throws ParameterException

Description copied from interface: ArgumentStack

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

Specified by:

remaining in interface ArgumentStack

Returns:

the value

Throws:

ParameterException - on a parameter error

getUnconsumed

public String getUnconsumed()

Get the unconsumed arguments left over, without touching the stack.

Returns:

the unconsumed arguments

markConsumed

public void markConsumed()

Description copied from interface: ArgumentStack

Set as completely consumed.

Specified by:

markConsumed in interface ArgumentStack

position

public int position()

Return the current position.

Returns:

the position

mark

public void mark()

Mark the current position of the stack.

The marked position initially starts at 0.

reset

public String reset()

Reset to the previously mark()ed position of the stack, and return the arguments that were consumed between this point and that previous point.

The marked position initially starts at 0.

Returns:

the consumed arguments

wasConsumed

public boolean wasConsumed()

Return whether any arguments were consumed between the marked position and the current position.

The marked position initially starts at 0.

Returns:

true if values were consumed.

getConsumed

public String getConsumed()

Return the arguments that were consumed between this point and that marked point.

The marked position initially starts at 0.

Returns:

the consumed arguments

getContext

public CommandContext getContext()

Get the underlying context.

Specified by:

getContext in interface ArgumentStack

Returns:

the context