Index
All Classes and Interfaces|All Packages
A
- add(E) - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.Parser
- addAliases(String...) - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.Option
-
Adds additional aliases to the option.
- addParameter(String) - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.Option
- askBoolean(String) - Static method in class eu.svjatoslav.commons.cli_helper.CLIHelper
-
Ask boolean value from user on command-line.
- askLong(String) - Static method in class eu.svjatoslav.commons.cli_helper.CLIHelper
-
Ask numerical long value from user on command-line.
- askString(String) - Static method in class eu.svjatoslav.commons.cli_helper.CLIHelper
-
Ask string value from user on command-line.
C
- CLIHelper - Class in eu.svjatoslav.commons.cli_helper
-
Command-line interface helper.
- CLIHelper() - Constructor for class eu.svjatoslav.commons.cli_helper.CLIHelper
D
- defaultValue - Variable in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.StringOption
- describeFormat() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.Option
- describeFormat() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.DirectoryOption
- describeFormat() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.DirectoryOptions
-
Returns a string describing the format of the option.
- describeFormat() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.FileOption
- describeFormat() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.FileOptions
- describeFormat() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.FloatOption
- describeFormat() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.IntegerOption
- describeFormat() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.NullOption
- describeFormat() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.StringOption
- describeFormat() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.StringOptions
- description - Variable in class eu.svjatoslav.commons.cli_helper.parameter_parser.Option
-
Purpose of this option, like: input image path, compression level, etc...
- DirectoryOption - Class in eu.svjatoslav.commons.cli_helper.parameter_parser.parameter
-
This class is used to define commandline option which accepts directory as parameter.
- DirectoryOption(String) - Constructor for class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.DirectoryOption
-
Constructor.
- DirectoryOptions - Class in eu.svjatoslav.commons.cli_helper.parameter_parser.parameter
-
DirectoryOptions class represents a command-line option for one or more directories.
- DirectoryOptions(String) - Constructor for class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.DirectoryOptions
-
Creates a new DirectoryOptions object with the given description.
- DOES_NOT_MATTER - Enum constant in enum class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.ExistenceType
-
Resource existence does not matter.
E
- eu.svjatoslav.commons.cli_helper - package eu.svjatoslav.commons.cli_helper
- eu.svjatoslav.commons.cli_helper.parameter_parser - package eu.svjatoslav.commons.cli_helper.parameter_parser
- eu.svjatoslav.commons.cli_helper.parameter_parser.parameter - package eu.svjatoslav.commons.cli_helper.parameter_parser.parameter
- ExistenceType - Enum Class in eu.svjatoslav.commons.cli_helper.parameter_parser.parameter
-
This enum is used to define if resource denoted by particular option parameter shall exist or not.
F
- FileOption - Class in eu.svjatoslav.commons.cli_helper.parameter_parser.parameter
-
This class represents commandline option which accepts exactly one parameter which is a file.
- FileOption(String) - Constructor for class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.FileOption
- FileOptions - Class in eu.svjatoslav.commons.cli_helper.parameter_parser.parameter
-
This class represents commandline option which accepts one or more parameters which are files.
- FileOptions(String) - Constructor for class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.FileOptions
- findParameterByAlias(String) - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.Parser
-
Return parameter by given alias or
nullif no parameter exists for given alias. - FloatOption - Class in eu.svjatoslav.commons.cli_helper.parameter_parser.parameter
- FloatOption(String) - Constructor for class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.FloatOption
G
- getAliasesAsString() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.Option
- getHelp() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.Option
-
Returns the help message for this parameter.
- getValue() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.Option
-
Returns the value of the object.
- getValue() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.DirectoryOption
-
Retrieves the value of the option as a
Fileobject. - getValue() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.DirectoryOptions
-
Returns the value of the option as a list of File objects.
- getValue() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.FileOption
- getValue() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.FileOptions
- getValue() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.FloatOption
- getValue() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.IntegerOption
- getValue() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.NullOption
- getValue() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.StringOption
- getValue() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.StringOptions
I
- IntegerOption - Class in eu.svjatoslav.commons.cli_helper.parameter_parser.parameter
-
This class represents commandline option which accepts exactly one parameter which is an integer.
- IntegerOption(String) - Constructor for class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.IntegerOption
- isMandatory() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.Option
- isPresent() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.Option
- isValid(String) - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.Option
- isValid(String) - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.DirectoryOption
-
This method checks if a provided directory path is valid based on the specified existence type.
- isValid(String) - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.DirectoryOptions
- isValid(String) - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.FileOption
- isValid(String) - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.FileOptions
- isValid(String) - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.FloatOption
- isValid(String) - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.IntegerOption
- isValid(String) - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.NullOption
- isValid(String) - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.StringOption
- isValid(String) - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.StringOptions
M
- mandatory - Variable in class eu.svjatoslav.commons.cli_helper.parameter_parser.Option
-
Indicates that at least one parameter is mandatory for this option.
- matchesAlias(String) - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.Option
- MUST_EXIST - Enum constant in enum class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.ExistenceType
-
Resource shall exist.
- MUST_NOT_EXIST - Enum constant in enum class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.ExistenceType
-
Resource shall not exist.
- mustExist() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.DirectoryOption
-
This method sets that directory shall exist.
- mustExist() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.DirectoryOptions
- mustExist() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.FileOption
-
This method sets that file shall exist.
- mustExist() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.FileOptions
-
This method is used to define that file shall exist in filesystem.
- mustNotExist() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.DirectoryOption
-
This method sets that directory shall not exist.
- mustNotExist() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.DirectoryOptions
- mustNotExist() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.FileOption
-
This method sets that file shall not exist.
- mustNotExist() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.FileOptions
-
This method is used to define that file shall not exist in filesystem.
N
- noMoreArguments() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.Option
-
Notifies this option that no more parameters will follow.
- NONE - Enum constant in enum class eu.svjatoslav.commons.cli_helper.parameter_parser.ParameterCount
-
Option has no parameters.
- NullOption - Class in eu.svjatoslav.commons.cli_helper.parameter_parser.parameter
-
This class represents commandline option which accepts exactly zero parameters.
- NullOption(String) - Constructor for class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.NullOption
O
- ONE - Enum constant in enum class eu.svjatoslav.commons.cli_helper.parameter_parser.ParameterCount
-
Option has exactly one mandatory parameter.
- ONE_OR_MORE - Enum constant in enum class eu.svjatoslav.commons.cli_helper.parameter_parser.ParameterCount
-
Option must have one or more parameters.
- Option<T,
I extends Option> - Class in eu.svjatoslav.commons.cli_helper.parameter_parser -
Represents an option that can be provided on CLI.
- Option(boolean, ParameterCount, String, String...) - Constructor for class eu.svjatoslav.commons.cli_helper.parameter_parser.Option
-
Represents an option that can be provided on CLI.
- Option(String, ParameterCount) - Constructor for class eu.svjatoslav.commons.cli_helper.parameter_parser.Option
P
- ParameterCount - Enum Class in eu.svjatoslav.commons.cli_helper.parameter_parser
-
This enumeration is used to define how many parameters does particular commandline option accept.
- parameters - Variable in class eu.svjatoslav.commons.cli_helper.parameter_parser.Option
-
List of arguments for this parameter.
- parse(String[]) - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.Parser
- Parser - Class in eu.svjatoslav.commons.cli_helper.parameter_parser
-
Single commandline parameter can have any amount of arguments.
- Parser() - Constructor for class eu.svjatoslav.commons.cli_helper.parameter_parser.Parser
S
- setMandatory() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.Option
-
Sets the option as mandatory.
- setPresent(boolean) - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.Option
-
Sets the present status of this parameter.
- showHelp() - Method in class eu.svjatoslav.commons.cli_helper.parameter_parser.Parser
- StringOption - Class in eu.svjatoslav.commons.cli_helper.parameter_parser.parameter
-
This class represents commandline option which accepts exactly one parameter which is a string.
- StringOption(String) - Constructor for class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.StringOption
- StringOption(String, String) - Constructor for class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.StringOption
- StringOptions - Class in eu.svjatoslav.commons.cli_helper.parameter_parser.parameter
-
This class represents commandline option which accepts one or more parameters which are strings.
- StringOptions(String) - Constructor for class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.StringOptions
V
- validateFile(ExistenceType, String) - Static method in class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.FileOption
- valueOf(String) - Static method in enum class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.ExistenceType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class eu.svjatoslav.commons.cli_helper.parameter_parser.ParameterCount
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class eu.svjatoslav.commons.cli_helper.parameter_parser.parameter.ExistenceType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class eu.svjatoslav.commons.cli_helper.parameter_parser.ParameterCount
-
Returns an array containing the constants of this enum class, in the order they are declared.
All Classes and Interfaces|All Packages