com.powsybl.tools

Class ToolOptions

java.lang.Object

com.powsybl.tools.ToolOptions

public class ToolOptions
extends java.lang.Object

Wrapper around CommandLine to provide a more user friendly syntax, in particular based on Optionals.

Author:

Sylvain Leclerc

Constructor Summary

Constructors

Constructor and Description
ToolOptions(org.apache.commons.cli.CommandLine line, java.nio.file.FileSystem fileSystem)
ToolOptions(org.apache.commons.cli.CommandLine line, ToolRunningContext context)

Method Summary

Modifier and Type	Method and Description
java.util.Optional<java.lang.Double>	getDouble(java.lang.String option) If exists, return the option value as a double.
<E extends java.lang.Enum<E>> java.util.Optional<E>	getEnum(java.lang.String option, java.lang.Class<E> clazz) If exists, return the option value as an enum.
java.util.Optional<java.lang.Float>	getFloat(java.lang.String option) If exists, return the option value as a float.
java.util.Optional<java.lang.Integer>	getInt(java.lang.String option) If exists, return the option value as an int.
java.util.Optional<java.nio.file.Path>	getPath(java.lang.String option) If exists, return the option value as a file system Path.
java.util.Optional<java.lang.String>	getValue(java.lang.String option) If exists, return the option value as a string.
<T> java.util.Optional<T>	getValue(java.lang.String option, java.util.function.Function<java.lang.String,T> parser) If exists, return the option value parsed with the provided parser.
java.util.Optional<java.util.List<java.lang.String>>	getValues(java.lang.String option) If exists, return the option value as a list of strings, assuming they were provided as a comma separated list.
boolean	hasOption(java.lang.String option) Return true if the option is defined.

Methods inherited from class java.lang.Object

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

Constructor Detail

ToolOptions

public ToolOptions(org.apache.commons.cli.CommandLine line,
                   java.nio.file.FileSystem fileSystem)

ToolOptions

public ToolOptions(org.apache.commons.cli.CommandLine line,
                   ToolRunningContext context)

Method Detail

getValue

public java.util.Optional<java.lang.String> getValue(java.lang.String option)

If exists, return the option value as a string.

Parameters:

option - The option name

Returns:

The option value as a string if it exists, otherwise empty.

getValue

public <T> java.util.Optional<T> getValue(java.lang.String option,
                                          java.util.function.Function<java.lang.String,T> parser)

If exists, return the option value parsed with the provided parser.

Parameters:

option - The option name

parser - A function to transform the value from string to target type.

Returns:

The option value parsed with the provided parser if it exists, otherwise empty.

getInt

public java.util.Optional<java.lang.Integer> getInt(java.lang.String option)

If exists, return the option value as an int.

Parameters:

option - The option name

Returns:

The option value as an int if it exists, otherwise empty.

getFloat

public java.util.Optional<java.lang.Float> getFloat(java.lang.String option)

If exists, return the option value as a float.

Parameters:

option - The option name

Returns:

The option value as a float if it exists, otherwise empty.

getDouble

public java.util.Optional<java.lang.Double> getDouble(java.lang.String option)

If exists, return the option value as a double.

Parameters:

option - The option name

Returns:

The option value as a double if it exists, otherwise empty.

getValues

public java.util.Optional<java.util.List<java.lang.String>> getValues(java.lang.String option)

If exists, return the option value as a list of strings, assuming they were provided as a comma separated list.

Parameters:

option - The option name

Returns:

The option value as a list of strings if it exists, otherwise empty.

getEnum

public <E extends java.lang.Enum<E>> java.util.Optional<E> getEnum(java.lang.String option,
                                                                   java.lang.Class<E> clazz)

If exists, return the option value as an enum.

Parameters:

option - The option name

clazz - The enum class

Returns:

The option value as as an enum. if it exists, otherwise empty.

hasOption

public boolean hasOption(java.lang.String option)

Return true if the option is defined.

Parameters:

option - The option name

Returns:

true if the option is defined.

getPath

public java.util.Optional<java.nio.file.Path> getPath(java.lang.String option)

If exists, return the option value as a file system Path.

Parameters:

option - The option name

Returns:

The option value as a double if it exists, otherwise empty.