Class ToolsOption
java.lang.Object
org.apache.commons.cli.Option
gov.nasa.pds.validate.commandline.options.ToolsOption
- All Implemented Interfaces:
Serializable
,Cloneable
public class ToolsOption
extends org.apache.commons.cli.Option
Class that extends Apache's Option class. Provides a simpler interface to
build command-line option flags.
- Author:
- mcayanan
- See Also:
- Serialized Form
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.commons.cli.Option
org.apache.commons.cli.Option.Builder
-
Field Summary
Fields inherited from class org.apache.commons.cli.Option
UNINITIALIZED, UNLIMITED_VALUES
-
Constructor Summary
Constructors Constructor Description ToolsOption(Flag flag)
ToolsOption(String opt, String longOpt, String description)
Constructor. -
Method Summary
Modifier and Type Method Description void
hasArg(String name, Object type)
Requires a single argument to follow the option.void
hasArg(String name, Object type, boolean isOptional)
Allows a single argument to be passed into the option.void
hasArgs(int numArgs, String name, Object type, char separator, boolean isOptional)
Defines an argument's "properties" for an option.void
hasArgs(String name, Object type)
Requires an argument to follow the option.void
hasArgs(String name, Object type, char separator)
Requires an argument to follow the option.void
hasArgs(String name, Object type, char separator, boolean isOptional)
Allows multiple arguments to be passed in to the option.Methods inherited from class org.apache.commons.cli.Option
addValue, builder, builder, clone, equals, getArgName, getArgs, getDescription, getId, getLongOpt, getOpt, getType, getValue, getValue, getValue, getValues, getValueSeparator, getValuesList, hasArg, hasArgName, hasArgs, hashCode, hasLongOpt, hasOptionalArg, hasValueSeparator, isRequired, setArgName, setArgs, setDescription, setLongOpt, setOptionalArg, setRequired, setType, setType, setValueSeparator, toString
-
Constructor Details
-
ToolsOption
Constructor.- Parameters:
opt
- Short name of the option.longOpt
- Long name of the option. Can be set to 'null'.description
- Description of the option.
-
ToolsOption
-
-
Method Details
-
hasArg
Requires a single argument to follow the option.- Parameters:
name
- Sets the display name of the argument value.type
- Sets the data type allowed for this argument.
-
hasArg
Allows a single argument to be passed into the option.- Parameters:
name
- Sets the display name of the argument value.type
- Sets the data type allowed for this argument.isOptional
- Set to 'true' if the argument is optional, 'false' otherwise.
-
hasArgs
Requires an argument to follow the option. This method allows the option to take in multiple arguments. Does not define a maximum number of allowable arguments. The separator value is set to the space character ' '.- Parameters:
name
- Sets the display name of the argument value.type
- Sets the data type allowed for this argument.
-
hasArgs
Requires an argument to follow the option. Allows multiple arguments to be passed in to the option. Does not define a maximum number of allowable arguments.- Parameters:
name
- Sets the display name of the argument value.type
- Sets the data type allowed for this argument.separator
- Sets the separator value allowed in between the argument values being passed in.
-
hasArgs
Allows multiple arguments to be passed in to the option. Does not define a maximum number of allowable arguments.- Parameters:
name
- Sets the display name of the argument value.type
- Sets the data type allowed for this argument.separator
- Sets the separator value allowed in between the argument values being passed in.isOptional
- Set to 'true' if an argument is optional, 'false' otherwise.
-
hasArgs
Defines an argument's "properties" for an option.- Parameters:
numArgs
- Max number of arguments allowed.name
- Sets the display name of the argument value.type
- Sets the data type allowed for this argument.separator
- Sets the separator value allowed in between the argument values being passed in.isOptional
- Set to 'true' if an argument is optional, 'false' otherwise.
-