ArgsOptionParser

public class ArgsOptionParser
extends OptionSetter

Mengisi kolom Option dari argumen command line yang diuraikan.

String di String yang diteruskan[] diuraikan dari kiri ke kanan. Setiap String diklasifikasikan sebagai opsi (seperti "-v"), opsi panjang (seperti "--verbose"), argumen ke opsi (misalnya "out.txt" di "-f out.txt"), atau argumen posisi non-opsi.

Setiap argumen opsi harus dipetakan ke satu atau beberapa kolom Option. Opsi panjang memetakan ke Nama Option, dan opsi singkat dipetakan ke nama pendek Option. Setiap opsi nama dan nama pendek opsi harus unik sehubungan dengan semua Kolom Option dalam objek yang sama.

Satu argumen opsi dapat dipetakan ke beberapa kolom Option dengan nama yang sama pada beberapa objek. Argumen Option dapat diberi namespace untuk merujuk secara unik ke Kolom Option dalam satu objek menggunakan nama class lengkap objek tersebut atau Nilai alias OptionClass dipisahkan dengan ':'. yakni

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

Opsi singkat yang sederhana adalah "-" diikuti dengan karakter opsi pendek. Jika opsi ini memerlukan (yang berlaku untuk opsi non-boolean apa pun), argumen tersebut dapat ditulis sebagai parameter terpisah, tetapi sebenarnya tidak demikian. Yaitu, "-f out.txt" dan "-fout.txt" keduanya dapat diterima.

Anda dapat menentukan beberapa opsi singkat setelah satu "-" selama semua (kecuali mungkin yang terakhir) tidak memerlukan argumen.

Opsi panjang dimulai dengan "--" diikuti oleh beberapa karakter. Jika opsi ini memerlukan , argumen tersebut dapat ditulis langsung setelah nama opsi, dipisahkan oleh "=", atau sebagai argumen. (Artinya, "--file=out.txt" atau "--file out.txt".)

Opsi panjang boolean '--name' otomatis mendapatkan '--no-name' pendamping. Jika ada opsi "--flag", lalu, "--flag", "--no-flag", "--flag=true" dan "--flag=false" semuanya valid, tapi bukan "--flag true" atau "--flag false" yang diizinkan (karena "--flag" itu sendiri sudah cukup, setelah "true" atau "false" ditafsirkan secara terpisah). Anda dapat menggunakan "yes" dan "tidak" sebagai sinonim untuk "true" dan "false".

Setiap String yang tidak dimulai dengan "-" dan bukan argumen yang dibutuhkan dari opsi sebelumnya adalah posisional non-opsi, seperti halnya semua String berturut-turut. Setiap String setelah "--" adalah posisional non-opsi.

Kolom yang sesuai dengan opsi akan diperbarui saat opsinya diproses. Sisanya argumen posisi dikembalikan sebagai List<String>.

Berikut adalah contoh sederhana:

 // 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) {
        ...
     }
     ...

 }

 

• halaman manual getopt(1)
• "optparse" Python modul (http://docs.python.org/library/optparse.html)
• "Panduan Sintaksis Utilitas" POSIX (http://www.opengroup.org/onlinepubs/000095399/basedefs/xbd_chap12.html#tag_12_02)
• program GNU "Standards for Command Line Interfaces" (http://www.gnu.org/prep/standards/standards.html#Command_002dLine-Interfaces)

Ringkasan

Konstruktor publik

public ArgsOptionParser ( optionSources)

public ArgsOptionParser (Object... optionSources)

Metode publik

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