ArgsOptionParser

public class ArgsOptionParser
extends OptionSetter

Propaga campos Option a partir de los argumentos de línea de comandos analizados.

Las cadenas en el String[] pasado se analizan de izquierda a derecha. Cada cadena se clasifica como un opción (como "-v"), una opción larga (como "--verbose"), un argumento de una opción (como “out.txt” in "-f out.txt"), o bien un argumento posicional de no opción.

Cada argumento de opción se debe asignar a uno o más campos Option. Una opción larga se asigna el nombre Option y una opción corta se asigna al nombre corto de Option. El nombre de cada opción y nombre corto de opción debe ser único con respecto a todos los demás Campos Option dentro del mismo objeto.

Un solo argumento de opción se puede asignar a varios campos Option con el mismo nombre en varios objetos. Se pueden asignar espacios de nombres a los argumentos Option para hacer referencia de forma única a un campo Option dentro de un único objeto que usa el nombre completo de la clase de ese objeto o su Valor de alias OptionClass separado por ":". es decir,

 --classname:optionname optionvalue or
 --optionclassalias:optionname optionvalue.
 

Una opción corta y sencilla es el símbolo "-" seguida de un carácter breve de opción. Si la opción requiere (que es verdadero para cualquier opción no booleana), se puede escribir como un parámetro separado, pero no tiene por qué serlo. Es decir, "-f out.txt" y "-fout.txt" son aceptables.

Es posible especificar varias opciones cortas después de un solo "-" tanto como todos (excepto posiblemente el último) no requieren argumentos.

Las opciones largas comienzan con "--" seguido de varios caracteres. Si la opción requiere se puede escribir directamente después del nombre de la opción, separado por "=", o como el siguiente argumento. (Es decir, "--file=out.txt" o "--file out.txt").

Una opción booleana larga ("--name") obtiene automáticamente el mensaje "--no-name" complementario. Dada una opción "--flag", luego, "--flag", "--no-flag", "--flag=true" y "--flag=false" todos son válidos, aunque no “--flag true” ni "--flag false" (dado que “--flag” por sí solo es suficiente, el después de "verdadero" o "false" se interpreta por separado). Puedes usar "yes" y "no" como sinónimos de "verdadero" y "false".

Cada cadena que no comience con "-" y no un argumento obligatorio de una opción previa es una argumento posicional de no opción, al igual que todas las strings sucesivas. Cada cadena después de un signo "--" es un argumento posicional de no opción.

Los campos correspondientes a las opciones se actualizan a medida que se procesan sus opciones. Cualquier restante los argumentos posicionales se muestran como una List<String>.

A continuación, te mostramos un ejemplo sencillo:

 // Non-@Option fields will be ignored.
 class Options {
     @Option(name = "quiet", shortName = 'q')
     boolean quiet = false;

     // Here the user can use --no-color.
     @Option(name = "color")
     boolean color = true;

     @Option(name = "mode", shortName = 'm')
     String mode = "standard; // Supply a default just by setting the field.

     @Option(name = "port", shortName = 'p')
     int portNumber = 8888;

     // There's no need to offer a short name for rarely-used options.
     @Option(name = "timeout" )
     double timeout = 1.0;

     @Option(name = "output-file", shortName = 'o' })
     File output;

     // Multiple options are added to the collection.
     // The collection field itself must be non-null.
     @Option(name = "input-file", shortName = 'i')
     List<File> inputs = new ArrayList<File>();

 }

 Options options = new Options();
 List<String> posArgs = new OptionParser(options).parse("--input-file", "/tmp/file1.txt");
 for (File inputFile : options.inputs) {
     if (!options.quiet) {
        ...
     }
     ...

 }

 

• la página del manual de getopt(1)
• “optparse” de Python módulo (http://docs.python.org/library/optparse.html)
• los “Lineamientos de sintaxis de utilidades” de POSIX (http://www.opengroup.org/onlinepubs/000095399/basedefs/xbd_chap12.html#tag_12_02).
• los "Estándares para interfaces de línea de comandos" de GNU (http://www.gnu.org/prep/standards/standards.html#Command_002dLine-Interfaces).

Resumen

Constructores públicos

public ArgsOptionParser ( optionSources)

public ArgsOptionParser (Object... optionSources)

Métodos públicos

public  getInopOptions ()

public static String getOptionHelp (boolean importantOnly, 
                Object optionObject)

   [-option_shortname, --option_name]          [option_description] Default:
   [current option field's value in optionObject]
 

public  parse (String... args)

public  parse ( args)

public  parseBestEffort ( args)

public  parseBestEffort ( args, 
                boolean forceContinue)

public  parseBestEffort (String... args)

public void validateMandatoryOptions ()