Module io.github.mmm.cli

Package io.github.mmm.cli

Class CliArgs

java.lang.Object

io.github.mmm.cli.CliArgs

public class CliArgs
extends Object

A simple wrapper for the arguments of a main method from a command-line-interface (CLI). Allows to easily iterate and parse these arguments.

Since:

1.0.0

See Also:

• CliArgs(String...)
• getFirst()

Constructor Summary

Constructors

Constructor	Description
CliArgs(String... args)	The constructor.

Method Summary

Modifier and Type	Method	Description
Set<String>	getDuplicatedOptions()
CliArgument	getFirst()
CliOption	getLastOption()
CliOption	getOption(boolean unique, String... options)
CliOption	getOption(boolean unique, Collection<String> options)
CliOption	getOption(String opt)
CliOption	getOption(String... options)
String[]	getOriginalArguments()
String	getOriginalArgumentsAsString()
int	getSize()
boolean	isEmpty()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

CliArgs

public CliArgs(String... args)

The constructor.

Parameters:

args - the command-line arguments from main method.

Method Details

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