ArgsOptionParser

public class ArgsOptionParser
extends OptionSetter

Remplit les champs Option à partir des arguments de ligne de commande analysés.

Les chaînes du String[] transmis sont analysées de gauche à droite. Chaque chaîne est classée comme une option courte (telle que "-v"), une option longue (telle que "--verbose"), un argument d'une option (telle que "out.txt" dans "-f out.txt "), ou un argument positionnel non optionnel.

Chaque argument d'option doit correspondre à un ou plusieurs champs Option . Une option longue correspond au nom Option et une option courte correspond au nom abrégé Option . Chaque nom d'option et nom abrégé d'option doit être unique par rapport à tous les autres champs Option dans le même objet.

Un seul argument d'option peut être mappé à plusieurs champs Option portant le même nom sur plusieurs objets. Les arguments Option peuvent avoir un espace de noms pour faire référence de manière unique à un champ Option dans un seul objet en utilisant le nom de classe complet de cet objet ou sa valeur d'alias OptionClass séparée par ':'. c'est-à-dire

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

Une option courte simple est un "-" suivi d'un caractère d'option courte. Si l'option nécessite un argument (ce qui est vrai pour toute option non booléenne), il peut être écrit comme paramètre séparé, mais ce n'est pas obligatoire. Autrement dit, "-f out.txt" et "-fout.txt" sont tous deux acceptables.

Il est possible de spécifier plusieurs options courtes après un seul "-" tant que toutes (sauf éventuellement la dernière) ne nécessitent pas d'arguments.

Une option longue commence par "--" suivi de plusieurs caractères. Si l'option nécessite un argument, il peut être écrit directement après le nom de l'option, séparé par "=", ou comme argument suivant. (C'est-à-dire "--file=out.txt" ou "--file out.txt".)

Une option booléenne longue '--name' obtient automatiquement un compagnon '--no-name'. Étant donné une option "--flag", alors, "--flag", "--no-flag", "--flag=true" et "--flag=false" sont tous valides, bien que ni "--flag true" ni "--flag false" ne sont autorisés (puisque "--flag" en lui-même est suffisant, le "true" ou "false" suivant est interprété séparément). Vous pouvez utiliser "oui" et "non" comme synonymes de "vrai" et "faux".

Chaque chaîne qui ne commence pas par un "-" et qui n'est pas un argument obligatoire d'une option précédente est un argument positionnel non optionnel, comme le sont toutes les chaînes successives. Chaque chaîne après un "--" est un argument positionnel non optionnel.

Les champs correspondant aux options sont mis à jour au fur et à mesure que leurs options sont traitées. Tous les arguments positionnels restants sont renvoyés sous forme de List<String>.

Voici un exemple 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 page de manuel getopt(1)
• Module "optparse" de Python (http://docs.python.org/library/optparse.html)
• les "Directives de syntaxe des utilitaires" POSIX (http://www.opengroup.org/onlinepubs/000095399/basedefs/xbd_chap12.html#tag_12_02)
• les "Standards for Command Line Interfaces" GNU (http://www.gnu.org/prep/standards/standards.html#Command_002dLine-Interfaces)

Résumé

Constructeurs publics

public ArgsOptionParser ( optionSources)

public ArgsOptionParser (Object... optionSources)

Méthodes publiques

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 ()