Package org.apache.commons.cli
Class OptionBuilder
- java.lang.Object
-
- org.apache.commons.cli.OptionBuilder
-
@Deprecated public final class OptionBuilder extends java.lang.Object
Deprecated.since 1.3, useOption.builder(String)
insteadOptionBuilder 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
- Version:
- $Id: OptionBuilder.java 1677400 2015-05-03 13:46:08Z britter $
-
-
Field Summary
Fields Modifier and Type Field Description private static java.lang.String
argName
Deprecated.argument nameprivate static java.lang.String
description
Deprecated.option descriptionprivate static OptionBuilder
INSTANCE
Deprecated.option builder instanceprivate static java.lang.String
longopt
Deprecated.long optionprivate static int
numberOfArgs
Deprecated.the number of argumentsprivate static boolean
optionalArg
Deprecated.option can have an optional argument valueprivate static boolean
required
Deprecated.is required?private static java.lang.Class<?>
type
Deprecated.option typeprivate static char
valuesep
Deprecated.value separator for argument value
-
Constructor Summary
Constructors Modifier Constructor Description private
OptionBuilder()
Deprecated.private constructor to prevent instances being created
-
Method Summary
All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static Option
create()
Deprecated.Create an Option using the current settingsstatic Option
create(char opt)
Deprecated.Create an Option using the current settings and with the specified Optionchar
.static Option
create(java.lang.String opt)
Deprecated.Create 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
hasOptionalArg()
Deprecated.The next Option can have an optional argument.static OptionBuilder
hasOptionalArgs()
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
isRequired()
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(java.lang.String name)
Deprecated.The next Option created will have the specified argument value name.static OptionBuilder
withDescription(java.lang.String newDescription)
Deprecated.The next Option created will have the specified descriptionstatic OptionBuilder
withLongOpt(java.lang.String newLongopt)
Deprecated.The next Option created will have the following long option value.static OptionBuilder
withType(java.lang.Class<?> newType)
Deprecated.The next Option created will have a value that will be an instance oftype
.static OptionBuilder
withType(java.lang.Object newType)
Deprecated.since 1.3, usewithType(Class)
insteadstatic OptionBuilder
withValueSeparator()
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 Detail
-
longopt
private static java.lang.String longopt
Deprecated.long option
-
description
private static java.lang.String description
Deprecated.option description
-
argName
private static java.lang.String argName
Deprecated.argument name
-
required
private static boolean required
Deprecated.is required?
-
numberOfArgs
private static int numberOfArgs
Deprecated.the number of arguments
-
type
private static java.lang.Class<?> type
Deprecated.option type
-
optionalArg
private static boolean optionalArg
Deprecated.option can have an optional argument value
-
valuesep
private static char valuesep
Deprecated.value separator for argument value
-
INSTANCE
private static final OptionBuilder INSTANCE
Deprecated.option builder instance
-
-
Method Detail
-
reset
private static void reset()
Deprecated.Resets the member variables to their default values.
-
withLongOpt
public static OptionBuilder withLongOpt(java.lang.String newLongopt)
Deprecated.The next Option created will have the following long option value.- Parameters:
newLongopt
- the long option value- Returns:
- the OptionBuilder instance
-
hasArg
public static OptionBuilder hasArg()
Deprecated.The next Option created will require an argument value.- Returns:
- the OptionBuilder instance
-
hasArg
public static OptionBuilder hasArg(boolean 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
-
withArgName
public static OptionBuilder withArgName(java.lang.String name)
Deprecated.The next Option created will have the specified argument value name.- Parameters:
name
- the name for the argument value- Returns:
- the OptionBuilder instance
-
isRequired
public static OptionBuilder isRequired()
Deprecated.The next Option created will be required.- Returns:
- the OptionBuilder instance
-
withValueSeparator
public static OptionBuilder withValueSeparator(char sep)
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
-
withValueSeparator
public static OptionBuilder 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
-
isRequired
public static OptionBuilder isRequired(boolean newRequired)
Deprecated.The next Option created will be required ifrequired
is true.- Parameters:
newRequired
- if true then the Option is required- Returns:
- the OptionBuilder instance
-
hasArgs
public static OptionBuilder hasArgs()
Deprecated.The next Option created can have unlimited argument values.- Returns:
- the OptionBuilder instance
-
hasArgs
public static OptionBuilder hasArgs(int num)
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
public static OptionBuilder hasOptionalArg()
Deprecated.The next Option can have an optional argument.- Returns:
- the OptionBuilder instance
-
hasOptionalArgs
public static OptionBuilder hasOptionalArgs()
Deprecated.The next Option can have an unlimited number of optional arguments.- Returns:
- the OptionBuilder instance
-
hasOptionalArgs
public static OptionBuilder hasOptionalArgs(int numArgs)
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
-
withType
@Deprecated public static OptionBuilder withType(java.lang.Object newType)
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
-
withType
public static OptionBuilder withType(java.lang.Class<?> newType)
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
-
withDescription
public static OptionBuilder withDescription(java.lang.String newDescription)
Deprecated.The next Option created will have the specified description- Parameters:
newDescription
- a description of the Option's purpose- Returns:
- the OptionBuilder instance
-
create
public static Option create(char opt) throws java.lang.IllegalArgumentException
Deprecated.Create an Option using the current settings and with the specified Optionchar
.- Parameters:
opt
- the character representation of the Option- Returns:
- the Option instance
- Throws:
java.lang.IllegalArgumentException
- ifopt
is not a valid character. See Option.
-
create
public static Option create() throws java.lang.IllegalArgumentException
Deprecated.Create an Option using the current settings- Returns:
- the Option instance
- Throws:
java.lang.IllegalArgumentException
- iflongOpt
has not been set.
-
create
public static Option create(java.lang.String opt) throws java.lang.IllegalArgumentException
Deprecated.Create 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:
java.lang.IllegalArgumentException
- ifopt
is not a valid character. See Option.
-
-