Constructor Detail

• CliArgs

  public CliArgs​(String... args)

  The constructor.

  Parameters:

  args - the command-line arguments from main method.

Method Detail

• getFirst

  public CliArgument getFirst()

  Returns:

  the first CliArgument.

  See Also:

  CliArgument.getNext(), getOption(String)

• getLastOption

  public CliOption getLastOption()

  Returns:

  the last CliOption from the arguments.

• isEmpty

  public boolean isEmpty()

  Returns:

  true if empty, false otherwise.

• getSize

  public int getSize()

  Returns:

  the number of CliArguments.

• getDuplicatedOptions

  public Set<String> getDuplicatedOptions()

  Returns:

  the Set with the CliOptions that have been duplicated.

• getOption

  public CliOption getOption​(String opt)

  Parameters:

  opt - the option string (e.g. "-h" or "--help" for help option).

  Returns:

  the requested CliOption or null if no such CliOption exists.

  See Also:

  getOption(String...)

• getOption

  public CliOption getOption​(String... options)

  Parameters:

  options - the array of option string (e.g. "-h" or "--help" for help option).

  Returns:

  the first matching CliOption or null if none of the given options exists.

• getOption

  public CliOption getOption​(boolean unique,
                             String... options)

  Parameters:

  unique - - true if not more than one of the given options should be defined (or a CliDuplicateOptionAliasException is thrown), false otherwise. Set this flag to true when you provide multiple synonym options such as a short and a long option.

  options - the array of option string (e.g. "-h" or "--help" for help option).

  Returns:

  the first matching CliOption or null if none of the given options exists.

  Throws:

  CliDuplicateOptionAliasException - in case unique is true and two of the given options have been found.

• getOption

  public CliOption getOption​(boolean unique,
                             Collection<String> options)

  Parameters:

  unique - - true if not more than one of the given options should be defined (or a CliDuplicateOptionAliasException is thrown), false otherwise. Set this flag to true when you provide multiple synonym options such as a short and a long option.

  options - the Collection of option string (e.g. "-h" or "--help" for help option).

  Returns:

  the first matching CliOption or null if none of the given options exists.

  Throws:

  CliDuplicateOptionAliasException - in case unique is true and two of the given options have been found.

• getOriginalArguments

  public String[] getOriginalArguments()

  Returns:

  the original arguments given at construction.

• getOriginalArgumentsAsString

  public String getOriginalArgumentsAsString()

  Returns:

  the original arguments as a single command-line String.

• toString

  public String toString()

  Overrides:

  toString in class Object