From bd48e765befa7a81456a98d43c912e6e919265a7 Mon Sep 17 00:00:00 2001 From: Claude Warren Date: Wed, 12 Jun 2024 16:09:13 +0200 Subject: [PATCH] updated properties documentation --- src/site/xdoc/properties.xml | 80 +++++++++++++++++++++--------------- 1 file changed, 46 insertions(+), 34 deletions(-) diff --git a/src/site/xdoc/properties.xml b/src/site/xdoc/properties.xml index 63112431b..e5e43f9d8 100644 --- a/src/site/xdoc/properties.xml +++ b/src/site/xdoc/properties.xml @@ -31,7 +31,7 @@ Option has. All of these can be set using the accessors or using the methods defined in the - OptionBuilder. + Option.Builder.

@@ -40,68 +40,80 @@ - - - + + + - - - + + + - + - + - - - + + + - - - + + + - - - + + + - - - + + + - + - + - - - + + + + + + + + - - + + - + - + + + + + +

Description
opt	java.lang.String	the identification string of the Option.	arg	boolean	A flag to say whether the option takes an argument.
longOpt	java.lang.String	an alias and more descriptive identification string	args	boolean	A flag to say whether the option takes more than one argument.
description	argName	java.lang.String	a description of the function of the option	The name of the argument value for the usage statement.
required	boolean	a flag to say whether the option must appear on - the command line.	converter	org.apache.commons.cli.Converter<T, E extends Throwable>	A FunctionalInterface that converts a String to type T and may throw an exception E. When + CommandLine.getParsedValue() is called this FunctionalInterface will perform the conversion from the + command line argument to the parsed type. This is used when a desired type is not registered, or to + provide a custom type implementation. The 'type' property is not required to use the 'converter' property.
arg	boolean	a flag to say whether the option takes an argument	deprecated	org.apache.commons.cli.DeprecatedAttributes	Marks the option as deprecated and has the deprecation properties.
args	boolean	a flag to say whether the option takes more than one argument	description	java.lang.String	A description of the function of the option.
optionalArg	boolean	a flag to say whether the option's argument is optional	longOpt	java.lang.String	An alias and more descriptive identification string. May be null or not specified if 'opt' is provided.
argName	opt	java.lang.String	the name of the argument value for the usage statement	The identification string of the Option. May be null or not specified if 'longOpt' is provided.
valueSeparator	char	the character value used to split the argument string, that - is used in conjunction with multipleArgs e.g. - if the separator is ',' and the argument string is 'a,b,c' then - there are three argument values, 'a', 'b' and 'c'.	optionalArg	boolean	A flag to say whether the option's argument is optional.
required	boolean	A flag to say whether the option must appear on the command line.
type	java.lang.Object	the type of the argument	java.lang.Class<?>	The class of the object returned from getParsedValue(). The class must be registered in TypeHandler instance. + See also 'converter' property.
value	java.lang.String	the value of the option	The value of the option.
values	java.lang.String[]	the values of the option	The values of the option.
valueSeparator	char	The character value used to split the argument string, that is used in conjunction with multipleArgs e.g. + if the separator is ',' and the argument string is 'a,b,c' then there are three argument values, 'a', 'b' + and 'c'.