Module id.xfunction

Package id.xfunction.cli

Class CommandOptions

Object

CommandOptions

public class CommandOptions
extends Object

Provides access to command line options. Options have key-value structure.

This class is only relying on Properties and so it is thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CommandOptions.Config

Constructor Summary

Constructors

Constructor	Description
CommandOptions(Properties options)

Method Summary

Modifier and Type	Method	Description
void	addOption(String name, boolean value)	Adds new option
static CommandOptions	collectOptions(CommandOptions.Config config, String[] args)	Collect command options from list of arguments.
static CommandOptions	collectOptions(String[] args)	Similar to collectOptions(String[]) except uses default CommandOptions.Config settings
Optional<String>	getOption(String optionName)	Some options may be optional.
Optional<Double>	getOptionDouble(String optionName)	Some options may be optional.
Optional<Integer>	getOptionInt(String optionName)	Some options may be optional.
String	getRequiredOption(String optionName)	If given option is not available it throws ArgumentParsingException with missing option name.
boolean	isOptionTrue(String optionName)	Check if optionName is set to "true": -optionName=true
String	toString()

Methods inherited from class Object

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

Constructor Details

CommandOptions

public CommandOptions(Properties options)

See Also:

• for creating CommandOptions from main(String[] args)

Method Details

collectOptions

public static CommandOptions collectOptions(CommandOptions.Config config,
 String[] args)
                                     throws ArgumentParsingException

Collect command options from list of arguments. Can be used with main(String[] args)

Each option may have zero or one argument.

If option has no argument then it is added with an empty string as a value.

Each option inside args should start from "-", or "--".

Options may accept arguments in one of the following ways: -option arg, -option=arg

When options are collected then leading "-" is removed.

Throws:

ArgumentParsingException

collectOptions

public static CommandOptions collectOptions(String[] args)
                                     throws ArgumentParsingException

Similar to collectOptions(String[]) except uses default CommandOptions.Config settings

Throws:

ArgumentParsingException

getRequiredOption

public String getRequiredOption(String optionName)
                         throws ArgumentParsingException

If given option is not available it throws ArgumentParsingException with missing option name.

It is recommended to catch ArgumentParsingException in the main() function itself and show user usage information.

Throws:

ArgumentParsingException

getOption

public Optional<String> getOption(String optionName)

Some options may be optional. Use this method to obtain them.

getOptionInt

public Optional<Integer> getOptionInt(String optionName)

Some options may be optional. Use this method to obtain them.

getOptionDouble

public Optional<Double> getOptionDouble(String optionName)

Some options may be optional. Use this method to obtain them.

isOptionTrue

public boolean isOptionTrue(String optionName)

Check if optionName is set to "true": -optionName=true

addOption

public void addOption(String name,
 boolean value)

Adds new option

toString

public String toString()

Overrides:

toString in class Object