ArgsOptionParser

public class ArgsOptionParser
extends OptionSetter

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

Las cadenas del String[] que se pasa se analizan de izquierda a derecha. Cada String 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 de 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. Los argumentos Option pueden tener un espacio de nombres para hacer referencia de forma única a un campo Option dentro de un solo objeto usando el nombre de clase completo de ese objeto o su valor de alias OptionClass separado por ":". es decir

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

Una opción abreviada simple es un guion seguido de un carácter de opción abreviada. Si la opción requiere un argumento (lo que sucede con cualquier opción no booleana), se puede escribir como un parámetro independiente, pero no es necesario. Es decir, "-f out.txt" y "-fout.txt" son aceptables.

Es posible especificar varias opciones cortas después de un solo "-", siempre y cuando 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 una opción complementaria "--no-name". Dada una opción "--flag", "--flag", "--no-flag", "--flag=true" y "--flag=false" son válidas, aunque no se permiten "--flag true" ni "--flag false" (ya que "--flag" por sí sola 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 comience con un guion "-" y que no sea un argumento obligatorio de una opción anterior es un argumento posicional que no es una opción, al igual que todas las cadenas sucesivas. Cada cadena después de "--" es un argumento posicional que no es una opción.

Los campos correspondientes a las opciones se actualizan a medida que se procesan las opciones. Los argumentos posicionales restantes se devuelven como una lista de cadenas.

Este es un ejemplo simple:

 // 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 de getopt(1)
• El módulo "optparse" de Python (http://docs.python.org/library/optparse.html)
• los "Lineamientos de sintaxis de 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 (Object... optionSources)

public ArgsOptionParser (Collection<Object> optionSources)

Métodos públicos

public Set<String> getInopOptions ()

public static String getOptionHelp (boolean importantOnly, 
                Object optionObject)

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

public List<String> parse (List<String> args)

public List<String> parse (String... args)

public List<String> parseBestEffort (List<String> args)

public List<String> parseBestEffort (List<String> args, 
                boolean forceContinue)

public List<String> parseBestEffort (String... args)

public void validateMandatoryOptions ()