org.spongepowered.api.command.args

Class CommandArgs

java.lang.Object

org.spongepowered.api.command.args.CommandArgs

public final class CommandArgs
extends Object

Holder for command arguments.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CommandArgs.Snapshot A snapshot of a CommandArgs.

Constructor Summary

Constructors

Constructor and Description
CommandArgs(String rawInput, List<SingleArg> args) Create a new CommandArgs instance with the given raw input and arguments.

Method Summary

Modifier and Type	Method and Description
void	applySnapshot(CommandArgs.Snapshot snapshot) Resets a CommandArgs to a previous state using a previously created CommandArgs.Snapshot.
void	applySnapshot(CommandArgs.Snapshot snapshot, boolean resetArgs) Resets a CommandArgs to a previous state using a previously created CommandArgs.Snapshot.
ArgumentParseException	createError(Text message) Create a parse exception with the provided message which has the position of the last parsed argument attached.
String	get(int index) Get an arg at the specified position.
List<String>	getAll() Gets a list of all arguments as a string.
String	getRaw() Return the raw string used to provide input to this arguments object.
int	getRawPosition() Gets the current position in raw input.
CommandArgs.Snapshot	getSnapshot() Gets a snapshot of the data inside this context to allow it to be restored later.
Object	getState() Deprecated. Use getSnapshot() and applySnapshot(Snapshot) instead
boolean	hasNext() Return whether more arguments remain to be read.
void	insertArg(String value) Insert an arg as the next arg to be returned by next().
String	next() Try to read the next argument, advancing the current index if successful.
Optional<String>	nextIfPresent() Try to read the next argument, advancing the current index if successful or returning an absent optional if not.
String	peek() Try to read the next argument without advancing the current index.
void	removeArgs(CommandArgs.Snapshot startSnapshot, CommandArgs.Snapshot endSnapshot) Remove the arguments parsed between two snapshots.
void	removeArgs(Object startState, Object endState) Deprecated. Use with getSnapshot() instead of getState() with removeArgs(Snapshot, Snapshot)
void	setState(Object state) Deprecated. Use getSnapshot() and applySnapshot(Snapshot) instead
int	size() Returns the number of arguments

Methods inherited from class java.lang.Object

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

Constructor Detail

CommandArgs

public CommandArgs(String rawInput,
                   List<SingleArg> args)

Create a new CommandArgs instance with the given raw input and arguments.

Parameters:

rawInput - Raw input

args - Arguments extracted from the raw input

Method Detail

hasNext

public boolean hasNext()

Return whether more arguments remain to be read.

Returns:

Whether more arguments remain

peek

public String peek()
            throws ArgumentParseException

Try to read the next argument without advancing the current index.

Returns:

The next argument

Throws:

ArgumentParseException - if not enough arguments are present

next

public String next()
            throws ArgumentParseException

Try to read the next argument, advancing the current index if successful.

Returns:

The next argument

Throws:

ArgumentParseException - if not enough arguments are present

nextIfPresent

public Optional<String> nextIfPresent()

Try to read the next argument, advancing the current index if successful or returning an absent optional if not.

Returns:

The optional next argument.

createError

public ArgumentParseException createError(Text message)

Create a parse exception with the provided message which has the position of the last parsed argument attached. The returned exception must be thrown at the target

Parameters:

message - The message for the exception

Returns:

the newly created, but unthrown exception

getAll

public List<String> getAll()

Gets a list of all arguments as a string. The returned list is immutable.

Returns:

all arguments

getState

@Deprecated
public Object getState()

Deprecated. Use getSnapshot() and applySnapshot(Snapshot) instead

Return this arguments object's current state. Can be used to reset with the setState(Object) method.

Returns:

The current state

setState

@Deprecated
public void setState(Object state)

Deprecated. Use getSnapshot() and applySnapshot(Snapshot) instead

Restore the arguments object's state to a state previously used.

Parameters:

state - the previous state

getRaw

public String getRaw()

Return the raw string used to provide input to this arguments object.

Returns:

The raw input

get

public String get(int index)

Get an arg at the specified position.

Parameters:

index - index of the element to return

insertArg

public void insertArg(String value)

Insert an arg as the next arg to be returned by next().

Parameters:

value - The argument to insert

removeArgs

@Deprecated
public void removeArgs(Object startState,
                                    Object endState)

Deprecated. Use with getSnapshot() instead of getState() with removeArgs(Snapshot, Snapshot)

Remove the arguments parsed between startState and endState.

Parameters:

startState - The starting state

endState - The ending state

removeArgs

public void removeArgs(CommandArgs.Snapshot startSnapshot,
                       CommandArgs.Snapshot endSnapshot)

Remove the arguments parsed between two snapshots.

Parameters:

startSnapshot - The starting state

endSnapshot - The ending state

size

public int size()

Returns the number of arguments

Returns:

the number of arguments

getRawPosition

public int getRawPosition()

Gets the current position in raw input.

Returns:

the raw position

getSnapshot

public CommandArgs.Snapshot getSnapshot()

Gets a snapshot of the data inside this context to allow it to be restored later.

Returns:

The CommandArgs.Snapshot containing the current state of the CommandArgs

applySnapshot

public void applySnapshot(CommandArgs.Snapshot snapshot)

Resets a CommandArgs to a previous state using a previously created CommandArgs.Snapshot.

Parameters:

snapshot - The CommandArgs.Snapshot to restore this context with

applySnapshot

public void applySnapshot(CommandArgs.Snapshot snapshot,
                          boolean resetArgs)

Resets a CommandArgs to a previous state using a previously created CommandArgs.Snapshot.

If resetArgs is set to false, this snapshot will not reset the argument list to its previous state, only the index.

Parameters:

snapshot - The CommandArgs.Snapshot to restore this context with

resetArgs - Whether to restore the argument list