com.sk89q.intake.parametric.argument

Class StringArgumentStack

java.lang.Object

com.sk89q.intake.parametric.argument.StringArgumentStack

All Implemented Interfaces:

ArgumentStack

public class StringArgumentStack
extends Object
implements ArgumentStack

A virtual scope that does not actually read from the underlying CommandContext.

Constructor Summary

Constructors

Constructor and Description
StringArgumentStack(CommandContext context, String[] arguments, boolean nonNullBoolean) Create a new instance using the given context.
StringArgumentStack(CommandContext context, String arguments, boolean nonNullBoolean) Create a new instance using the given context.

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.

Methods inherited from class java.lang.Object

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

Constructor Detail

StringArgumentStack

public StringArgumentStack(CommandContext context,
                           String[] arguments,
                           boolean nonNullBoolean)

Create a new instance using the given context.

Parameters:

context - the context

arguments - a list of arguments

nonNullBoolean - true to have nextBoolean() return false instead of null

StringArgumentStack

public StringArgumentStack(CommandContext context,
                           String arguments,
                           boolean nonNullBoolean)

Create a new instance using the given context.

Parameters:

context - the context

arguments - an argument string to be parsed

nonNullBoolean - true to have nextBoolean() return false instead of null

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

markConsumed

public void markConsumed()

Description copied from interface: ArgumentStack

Set as completely consumed.

Specified by:

markConsumed in interface ArgumentStack

getContext

public CommandContext getContext()

Description copied from interface: ArgumentStack

Get the underlying context.

Specified by:

getContext in interface ArgumentStack

Returns:

the context