ArgsOptionParser

public class ArgsOptionParser
extends OptionSetter

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

Las cadenas de la String[] pasada se analizan de izquierda a derecha. Cada cadena se clasifica como una opción corta (como "-v"), una opción larga (como "--verbose"), un argumento para una opción (como "out.txt" en "-f out.txt") o un argumento posicional que no es una opción.

Cada argumento de opción debe asignarse a uno o más campos Option. Una opción larga se asigna al nombre Option y una opción corta se asigna al nombre corto Option. Cada nombre y nombre corto de la opción deben ser únicos en relación con 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 solo objeto mediante 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 "-" seguido de un carácter corto. Si la opción requiere un argumento (lo que es cierto para cualquier opción que no sea booleana), se puede escribir como un parámetro independiente, pero no es necesario. Es decir, se aceptan “-f out.txt” y “-fout.txt”.

Es posible especificar varias opciones cortas después de un solo "-", siempre que todas (excepto posiblemente la última) no requieran argumentos.

Una opción larga comienza con “--” seguido de varios caracteres. Si la opción requiere un argumento, 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 larga booleana "--name" obtiene automáticamente un complemento "--no-name". Dada una opción "--flag", "--flag", "--no-flag", "--flag=true" y "--flag=false" son válidos, aunque no se permiten "--flag true" ni "--flag false" (ya que "--flag" por sí solo es suficiente, el siguiente "true" o "false" se interpreta por separado). Puedes usar "sí" y "no" como sinónimos de "verdadero" y "falso".

Cada cadena que no comienza con un “-” y que no es un argumento obligatorio de una opción anterior es un argumento posicional no opcional, al igual que todas las cadenas sucesivas. Cada cadena después de un “--” es un argumento posicional que no es de opción.

Los campos correspondientes a las opciones se actualizan a medida que se procesan. Cualquier argumento posicional restante se muestra como una List<String>.

Este es 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 man getopt(1)
• El módulo “optparse” de Python (http://docs.python.org/library/optparse.html)
• los "Lineamientos de sintaxis de la utilidad" 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 ()