Package org.apache.commons.cli
Class OptionBuilder
java.lang.Object
org.apache.commons.cli.OptionBuilder
Deprecated.
OptionBuilder allows the user to create Options using descriptive methods.
Details on the Builder pattern can be found at http://c2.com/cgi-bin/wiki?BuilderPattern.
This class is NOT thread safe. See CLI-209
- Since:
- 1.0
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static int
Deprecated.The number of argumentsprivate static String
Deprecated.Argument nameprivate static String
Deprecated.Option descriptionprivate static final OptionBuilder
Deprecated.Option builder instanceprivate static String
Deprecated.Long optionprivate static boolean
Deprecated.Option can have an optional argument valueprivate static boolean
Deprecated.Is required?private static Class<?>
Deprecated.Option typeprivate static char
Deprecated.Value separator for argument value -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
Deprecated.private constructor to prevent instances being created -
Method Summary
Modifier and TypeMethodDescriptionstatic Option
create()
Deprecated.Creates an Option using the current settingsstatic Option
create
(char opt) Deprecated.Creates an Option using the current settings and with the specified Optionchar
.static Option
Deprecated.Creates an Option using the current settings and with the specified Optionchar
.static OptionBuilder
hasArg()
Deprecated.The next Option created will require an argument value.static OptionBuilder
hasArg
(boolean hasArg) Deprecated.The next Option created will require an argument value ifhasArg
is true.static OptionBuilder
hasArgs()
Deprecated.The next Option created can have unlimited argument values.static OptionBuilder
hasArgs
(int num) Deprecated.The next Option created can havenum
argument values.static OptionBuilder
Deprecated.The next Option can have an optional argument.static OptionBuilder
Deprecated.The next Option can have an unlimited number of optional arguments.static OptionBuilder
hasOptionalArgs
(int numArgs) Deprecated.The next Option can have the specified number of optional arguments.static OptionBuilder
Deprecated.The next Option created will be required.static OptionBuilder
isRequired
(boolean newRequired) Deprecated.The next Option created will be required ifrequired
is true.private static void
reset()
Deprecated.Resets the member variables to their default values.static OptionBuilder
withArgName
(String name) Deprecated.The next Option created will have the specified argument value name.static OptionBuilder
withDescription
(String newDescription) Deprecated.The next Option created will have the specified descriptionstatic OptionBuilder
withLongOpt
(String newLongopt) Deprecated.The next Option created will have the following long option value.static OptionBuilder
Deprecated.The next Option created will have a value that will be an instance oftype
.static OptionBuilder
Deprecated.since 1.3, usewithType(Class)
insteadstatic OptionBuilder
Deprecated.The next Option created uses '=
' as a means to separate argument values.static OptionBuilder
withValueSeparator
(char sep) Deprecated.The next Option created usessep
as a means to separate argument values.
-
Field Details
-
longOption
Deprecated.Long option -
description
Deprecated.Option description -
argName
Deprecated.Argument name -
required
private static boolean requiredDeprecated.Is required? -
argCount
private static int argCountDeprecated.The number of arguments -
type
Deprecated.Option type -
optionalArg
private static boolean optionalArgDeprecated.Option can have an optional argument value -
valueSeparator
private static char valueSeparatorDeprecated.Value separator for argument value -
INSTANCE
Deprecated.Option builder instance
-
-
Constructor Details
-
OptionBuilder
private OptionBuilder()Deprecated.private constructor to prevent instances being created
-
-
Method Details
-
create
Deprecated.Creates an Option using the current settings- Returns:
- the Option instance
- Throws:
IllegalArgumentException
- iflongOpt
has not been set.
-
create
Deprecated.Creates an Option using the current settings and with the specified Optionchar
.- Parameters:
opt
- the character representation of the Option- Returns:
- the Option instance
- Throws:
IllegalArgumentException
- ifopt
is not a valid character. See Option.
-
create
Deprecated.Creates an Option using the current settings and with the specified Optionchar
.- Parameters:
opt
- thejava.lang.String
representation of the Option- Returns:
- the Option instance
- Throws:
IllegalArgumentException
- ifopt
is not a valid character. See Option.
-
hasArg
Deprecated.The next Option created will require an argument value.- Returns:
- the OptionBuilder instance
-
hasArg
Deprecated.The next Option created will require an argument value ifhasArg
is true.- Parameters:
hasArg
- if true then the Option has an argument value- Returns:
- the OptionBuilder instance
-
hasArgs
Deprecated.The next Option created can have unlimited argument values.- Returns:
- the OptionBuilder instance
-
hasArgs
Deprecated.The next Option created can havenum
argument values.- Parameters:
num
- the number of args that the option can have- Returns:
- the OptionBuilder instance
-
hasOptionalArg
Deprecated.The next Option can have an optional argument.- Returns:
- the OptionBuilder instance
-
hasOptionalArgs
Deprecated.The next Option can have an unlimited number of optional arguments.- Returns:
- the OptionBuilder instance
-
hasOptionalArgs
Deprecated.The next Option can have the specified number of optional arguments.- Parameters:
numArgs
- - the maximum number of optional arguments the next Option created can have.- Returns:
- the OptionBuilder instance
-
isRequired
Deprecated.The next Option created will be required.- Returns:
- the OptionBuilder instance
-
isRequired
Deprecated.The next Option created will be required ifrequired
is true.- Parameters:
newRequired
- if true then the Option is required- Returns:
- the OptionBuilder instance
-
reset
private static void reset()Deprecated.Resets the member variables to their default values. -
withArgName
Deprecated.The next Option created will have the specified argument value name.- Parameters:
name
- the name for the argument value- Returns:
- the OptionBuilder instance
-
withDescription
Deprecated.The next Option created will have the specified description- Parameters:
newDescription
- a description of the Option's purpose- Returns:
- the OptionBuilder instance
-
withLongOpt
Deprecated.The next Option created will have the following long option value.- Parameters:
newLongopt
- the long option value- Returns:
- the OptionBuilder instance
-
withType
Deprecated.The next Option created will have a value that will be an instance oftype
.- Parameters:
newType
- the type of the Options argument value- Returns:
- the OptionBuilder instance
- Since:
- 1.3
-
withType
Deprecated.since 1.3, usewithType(Class)
insteadThe next Option created will have a value that will be an instance oftype
.Note: this method is kept for binary compatibility and the input type is supposed to be a
Class
object.- Parameters:
newType
- the type of the Options argument value- Returns:
- the OptionBuilder instance
-
withValueSeparator
Deprecated.The next Option created uses '=
' as a means to separate argument values. Example:Option opt = OptionBuilder.withValueSeparator().create('D'); CommandLine line = parser.parse(args); String propertyName = opt.getValue(0); String propertyValue = opt.getValue(1);
- Returns:
- the OptionBuilder instance
-
withValueSeparator
Deprecated.The next Option created usessep
as a means to separate argument values.Example:
Option opt = OptionBuilder.withValueSeparator('=').create('D'); String args = "-Dkey=value"; CommandLine line = parser.parse(args); String propertyName = opt.getValue(0); // will be "key" String propertyValue = opt.getValue(1); // will be "value"
- Parameters:
sep
- The value separator to be used for the argument values.- Returns:
- the OptionBuilder instance
-
Option.builder(String)
instead