public class ToolOptions
extends java.lang.Object
CommandLine
to provide a more user friendly syntax,
in particular based on Optional
s.Constructor and Description |
---|
ToolOptions(org.apache.commons.cli.CommandLine line,
ToolRunningContext context) |
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>> |
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.
|
public ToolOptions(org.apache.commons.cli.CommandLine line, ToolRunningContext context)
public java.util.Optional<java.lang.String> getValue(java.lang.String option)
option
- The option namepublic <T> java.util.Optional<T> getValue(java.lang.String option, java.util.function.Function<java.lang.String,T> parser)
option
- The option nameparser
- A function to transform the value from string to target type.public java.util.Optional<java.lang.Integer> getInt(java.lang.String option)
option
- The option namepublic java.util.Optional<java.lang.Float> getFloat(java.lang.String option)
option
- The option namepublic java.util.Optional<java.lang.Double> getDouble(java.lang.String option)
option
- The option namepublic java.util.Optional<java.util.List<java.lang.String>> getValues(java.lang.String option)
option
- The option namepublic <E extends java.lang.Enum<E>> java.util.Optional<E> getEnum(java.lang.String option, java.lang.Class<E> clazz)
option
- The option nameclazz
- The enum classpublic boolean hasOption(java.lang.String option)
option
- The option nametrue
if the option is defined.public java.util.Optional<java.nio.file.Path> getPath(java.lang.String option)
Path
.option
- The option name