| Modifier and Type | Method and Description |
|---|---|
Option.Builder |
argName(String argName)
Sets the display name for the argument value.
|
Option |
build()
Constructs an Option with the values declared by this
Option.Builder. |
Option.Builder |
desc(String description)
Sets the description for this option.
|
Option.Builder |
hasArg()
Indicates that the Option will require an argument.
|
Option.Builder |
hasArg(boolean hasArg)
Indicates if the Option has an argument or not.
|
Option.Builder |
hasArgs()
Indicates that the Option can have unlimited argument values.
|
Option.Builder |
longOpt(String longOpt)
Sets the long name of the Option.
|
Option.Builder |
numberOfArgs(int numberOfArgs)
Sets the number of argument values the Option can take.
|
Option.Builder |
option(String option)
Sets the name of the Option.
|
Option.Builder |
optionalArg(boolean isOptional)
Sets whether the Option can have an optional argument.
|
Option.Builder |
required()
Marks this Option as required.
|
Option.Builder |
required(boolean required)
Sets whether the Option is mandatory.
|
Option.Builder |
type(Class<?> type)
Sets the type of the Option.
|
Option.Builder |
valueSeparator()
The Option will use '=' as a means to separate argument value.
|
Option.Builder |
valueSeparator(char sep)
The Option will use
sep as a means to separate argument values. |
public Option.Builder argName(String argName)
argName - the display name for the argument value.public Option build()
Option.Builder.OptionIllegalArgumentException - if neither opt or longOpt has been setpublic Option.Builder desc(String description)
description - the description of the option.public Option.Builder hasArg()
public Option.Builder hasArg(boolean hasArg)
hasArg - specifies whether the Option takes an argument or notpublic Option.Builder hasArgs()
public Option.Builder longOpt(String longOpt)
longOpt - the long name of the Optionpublic Option.Builder numberOfArgs(int numberOfArgs)
numberOfArgs - the number of argument valuespublic Option.Builder option(String option) throws IllegalArgumentException
option - the name of the OptionIllegalArgumentException - if there are any non valid Option characters in optpublic Option.Builder optionalArg(boolean isOptional)
isOptional - specifies whether the Option can have an optional argument.public Option.Builder required()
public Option.Builder required(boolean required)
required - specifies whether the Option is mandatorypublic Option.Builder type(Class<?> type)
type - the type of the Optionpublic Option.Builder valueSeparator()
public Option.Builder valueSeparator(char sep)
sep as a means to separate argument values.
Example:
Option opt = Option.builder("D").hasArgs().valueSeparator('=').build();
Options options = new Options();
options.addOption(opt);
String[] args = {"-Dkey=value"};
CommandLineParser parser = new DefaultParser();
CommandLine line = parser.parse(options, args);
String propertyName = line.getOptionValues("D")[0]; // will be "key"
String propertyValue = line.getOptionValues("D")[1]; // will be "value"
sep - The value separator.Copyright © 2002–2020 The Apache Software Foundation. All rights reserved.