Field Detail

• command

  protected final java.lang.String command

• parsedArgs

  protected final java.util.List<java.lang.String> parsedArgs

• originalArgIndices

  protected final java.util.List<java.lang.Integer> originalArgIndices

• originalArgs

  protected final java.lang.String[] originalArgs

• booleanFlags

  protected final java.util.Set<java.lang.Character> booleanFlags

• valueFlags

  protected final java.util.Map<java.lang.Character,java.lang.String> valueFlags

• suggestionContext

  protected final SuggestionContext suggestionContext

• locals

  protected final CommandLocals locals

Constructor Detail

• CommandContext

  public CommandContext(java.lang.String args)
                 throws CommandException

  Throws:

  CommandException

• CommandContext

  public CommandContext(java.lang.String[] args)
                 throws CommandException

  Throws:

  CommandException

• CommandContext

  public CommandContext(java.lang.String args,
                        java.util.Set<java.lang.Character> valueFlags)
                 throws CommandException

  Throws:

  CommandException

• CommandContext

  public CommandContext(java.lang.String args,
                        java.util.Set<java.lang.Character> valueFlags,
                        boolean allowHangingFlag)
                 throws CommandException

  Throws:

  CommandException

• CommandContext

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

  Throws:

  CommandException

• CommandContext

  public CommandContext(java.lang.String[] args,
                        java.util.Set<java.lang.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(java.lang.String[] args,
                        java.util.Set<java.lang.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 Detail

• split

  public static java.lang.String[] split(java.lang.String args)

• getSuggestionContext

  public SuggestionContext getSuggestionContext()

• getCommand

  public java.lang.String getCommand()

• matches

  public boolean matches(java.lang.String command)

• getString

  public java.lang.String getString(int index)

• getString

  public java.lang.String getString(int index,
                                    java.lang.String def)

• getJoinedStrings

  public java.lang.String getJoinedStrings(int initialIndex)

• getRemainingString

  public java.lang.String getRemainingString(int start)

• getString

  public java.lang.String getString(int start,
                                    int end)

• getInteger

  public int getInteger(int index)
                 throws java.lang.NumberFormatException

  Throws:

  java.lang.NumberFormatException

• getInteger

  public int getInteger(int index,
                        int def)
                 throws java.lang.NumberFormatException

  Throws:

  java.lang.NumberFormatException

• getDouble

  public double getDouble(int index)
                   throws java.lang.NumberFormatException

  Throws:

  java.lang.NumberFormatException

• getDouble

  public double getDouble(int index,
                          double def)
                   throws java.lang.NumberFormatException

  Throws:

  java.lang.NumberFormatException

• getSlice

  public java.lang.String[] getSlice(int index)

• getPaddedSlice

  public java.lang.String[] getPaddedSlice(int index,
                                           int padding)

• getParsedSlice

  public java.lang.String[] getParsedSlice(int index)

• getParsedPaddedSlice

  public java.lang.String[] getParsedPaddedSlice(int index,
                                                 int padding)

• hasFlag

  public boolean hasFlag(char ch)

• getFlags

  public java.util.Set<java.lang.Character> getFlags()

• getValueFlags

  public java.util.Map<java.lang.Character,java.lang.String> getValueFlags()

• getFlag

  public java.lang.String getFlag(char ch)

• getFlag

  public java.lang.String getFlag(char ch,
                                  java.lang.String def)

• getFlagInteger

  public int getFlagInteger(char ch)
                     throws java.lang.NumberFormatException

  Throws:

  java.lang.NumberFormatException

• getFlagInteger

  public int getFlagInteger(char ch,
                            int def)
                     throws java.lang.NumberFormatException

  Throws:

  java.lang.NumberFormatException

• getFlagDouble

  public double getFlagDouble(char ch)
                       throws java.lang.NumberFormatException

  Throws:

  java.lang.NumberFormatException

• getFlagDouble

  public double getFlagDouble(char ch,
                              double def)
                       throws java.lang.NumberFormatException

  Throws:

  java.lang.NumberFormatException

• argsLength

  public int argsLength()

• getLocals

  public CommandLocals getLocals()