java.lang.Object

com.sk89q.minecraft.util.commands.CommandContext

public class CommandContext extends Object

Field Summary

Fields

Modifier and Type

Field

Description

protected final Set<Character>

booleanFlags

protected final String

command

protected final CommandLocals

locals

protected final List<Integer>

originalArgIndices

protected final String[]

originalArgs

protected final List<String>

parsedArgs

protected final SuggestionContext

suggestionContext

protected final Map<Character,String>

valueFlags
Constructor Summary

Constructors

Constructor

Description

CommandContext(String args)

CommandContext(String[] args)

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

CommandContext(String[] args, Set<Character> valueFlags, boolean allowHangingFlag, CommandLocals locals)

Parse the given array of arguments.

CommandContext(String[] args, Set<Character> valueFlags, boolean allowHangingFlag, CommandLocals locals, boolean parseFlags)

Parse the given array of arguments.

CommandContext(String args, Set<Character> valueFlags)

CommandContext(String args, Set<Character> valueFlags, boolean allowHangingFlag)
Method Summary

Modifier and Type

Method

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)

CommandLocals

getLocals()

String[]

getPaddedSlice(int index, int padding)

String[]

getParsedPaddedSlice(int index, int padding)

String[]

getParsedSlice(int index)

String

getRemainingString(int start)

String[]

getSlice(int index)

String

getString(int index)

String

getString(int start, int end)

String

getString(int index, String def)

SuggestionContext

getSuggestionContext()

Map<Character,String>

getValueFlags()

boolean

hasFlag(char ch)

boolean

matches(String command)

static String[]

split(String args)

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details
- 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
- suggestionContext
  
  protected final SuggestionContext suggestionContext
- locals
  
  protected final CommandLocals locals
Constructor Details
- 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, boolean allowHangingFlag) throws CommandException
  
  Throws:
  
  CommandException
- CommandContext
  
  public CommandContext(String[] args, Set<Character> valueFlags) throws CommandException
  
  Throws:
  
  CommandException
- CommandContext
  
  public CommandContext(String[] args, Set<Character> valueFlags, boolean allowHangingFlag, CommandLocals locals) throws CommandException
  
  Parse the given array of arguments.
  Empty arguments are removed from the list of arguments.
  
  Parameters:
  
  args - an array with arguments
  
  valueFlags - a set containing all value flags (pass null to disable value flag parsing)
  
  allowHangingFlag - true if hanging flags are allowed
  
  locals - the locals, null to create empty one
  
  Throws:
  
  CommandException - thrown on a parsing error
- CommandContext
  
  public CommandContext(String[] args, Set<Character> valueFlags, boolean allowHangingFlag, CommandLocals locals, boolean parseFlags) throws CommandException
  
  Parse the given array of arguments.
  Empty arguments are removed from the list of arguments.
  
  Parameters:
  
  args - an array with arguments
  
  valueFlags - a set containing all value flags (pass null to disable value flag parsing)
  
  allowHangingFlag - true if hanging flags are allowed
  
  locals - the locals, null to create empty one
  
  parseFlags - where to parse flags
  
  Throws:
  
  CommandException - thrown on a parsing error
Method Details
- split
  
  public static String[] split(String args)
- getSuggestionContext
  
  public SuggestionContext getSuggestionContext()
- 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)
- getRemainingString
  
  public String getRemainingString(int start)
- getString
  
  public String getString(int start, int end)
- 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()
- getLocals
  
  public CommandLocals getLocals()

Class CommandContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Details

command

parsedArgs

originalArgIndices

originalArgs

booleanFlags

valueFlags

suggestionContext

locals

Constructor Details

CommandContext

CommandContext

CommandContext

CommandContext

CommandContext

CommandContext

CommandContext

Method Details

split

getSuggestionContext

getCommand

matches

getString

getString

getJoinedStrings

getRemainingString

getString

getInteger

getInteger

getDouble

getDouble

getSlice

getPaddedSlice

getParsedSlice

getParsedPaddedSlice

hasFlag

getFlags

getValueFlags

getFlag

getFlag

getFlagInteger

getFlagInteger

getFlagDouble

getFlagDouble

argsLength

getLocals