com.sk89q.minecraft.util.commands

Class CommandContext

java.lang.Object

com.sk89q.minecraft.util.commands.CommandContext

public class CommandContext
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<Character>	booleanFlags
protected String	command
protected List<Integer>	originalArgIndices
protected String[]	originalArgs
protected List<String>	parsedArgs
protected Map<Character,String>	valueFlags

Constructor Summary

Constructors

Constructor and Description
CommandContext(String args)
CommandContext(String[] args)
CommandContext(String[] args, Set<Character> valueFlags)
CommandContext(String args, Set<Character> valueFlags)

Method Summary

Methods

Modifier and Type	Method and Description
int	argsLength()
String	getCommand()
double	getDouble(int index)
double	getDouble(int index, double def)
String	getFlag(char ch)
String	getFlag(char ch, String def)
double	getFlagDouble(char ch)
double	getFlagDouble(char ch, double def)
int	getFlagInteger(char ch)
int	getFlagInteger(char ch, int def)
Set<Character>	getFlags()
int	getInteger(int index)
int	getInteger(int index, int def)
String	getJoinedStrings(int initialIndex)
String[]	getPaddedSlice(int index, int padding)
String[]	getParsedPaddedSlice(int index, int padding)
String[]	getParsedSlice(int index)
String[]	getSlice(int index)
String	getString(int index)
String	getString(int index, String def)
Map<Character,String>	getValueFlags()
boolean	hasFlag(char ch)
boolean	matches(String command)

Methods inherited from class java.lang.Object

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

Field Detail

command

protected final String command

parsedArgs

protected final List<String> parsedArgs

originalArgIndices

protected final List<Integer> originalArgIndices

originalArgs

protected final String[] originalArgs

booleanFlags

protected final Set<Character> booleanFlags

valueFlags

protected final Map<Character,String> valueFlags

Constructor Detail

CommandContext

public CommandContext(String args)
               throws CommandException

Throws:

CommandException

CommandContext

public CommandContext(String[] args)
               throws CommandException

Throws:

CommandException

CommandContext

public CommandContext(String args,
              Set<Character> valueFlags)
               throws CommandException

Throws:

CommandException

CommandContext

public CommandContext(String[] args,
              Set<Character> valueFlags)
               throws CommandException

Parameters:

args - An array with arguments. Empty strings outside quotes will be removed.

valueFlags - A set containing all value flags. Pass null to disable value flag parsing.

Throws:

CommandException - This is thrown if flag fails for some reason.

Method Detail

getCommand

public String getCommand()

matches

public boolean matches(String command)

getString

public String getString(int index)

getString

public String getString(int index,
               String def)

getJoinedStrings

public String getJoinedStrings(int initialIndex)

getInteger

public int getInteger(int index)
               throws NumberFormatException

Throws:

NumberFormatException

getInteger

public int getInteger(int index,
             int def)
               throws NumberFormatException

Throws:

NumberFormatException

getDouble

public double getDouble(int index)
                 throws NumberFormatException

Throws:

NumberFormatException

getDouble

public double getDouble(int index,
               double def)
                 throws NumberFormatException

Throws:

NumberFormatException

getSlice

public String[] getSlice(int index)

getPaddedSlice

public String[] getPaddedSlice(int index,
                      int padding)

getParsedSlice

public String[] getParsedSlice(int index)

getParsedPaddedSlice

public String[] getParsedPaddedSlice(int index,
                            int padding)

hasFlag

public boolean hasFlag(char ch)

getFlags

public Set<Character> getFlags()

getValueFlags

public Map<Character,String> getValueFlags()

getFlag

public String getFlag(char ch)

getFlag

public String getFlag(char ch,
             String def)

getFlagInteger

public int getFlagInteger(char ch)
                   throws NumberFormatException

Throws:

NumberFormatException

getFlagInteger

public int getFlagInteger(char ch,
                 int def)
                   throws NumberFormatException

Throws:

NumberFormatException

getFlagDouble

public double getFlagDouble(char ch)
                     throws NumberFormatException

Throws:

NumberFormatException

getFlagDouble

public double getFlagDouble(char ch,
                   double def)
                     throws NumberFormatException

Throws:

NumberFormatException

argsLength

public int argsLength()