ArgsOptionParser

public class ArgsOptionParser
extends OptionSetter

पार्स किए गए कमांड लाइन आर्ग्युमेंट से Option फ़ील्ड को पॉप्युलेट करता है.

पास की गई String[] में मौजूद स्ट्रिंग को बाएं से दाएं पार्स किया जाता है. हर स्ट्रिंग को छोटे विकल्प (जैसे, "-v"), लंबे विकल्प (जैसे, "--verbose"), विकल्प के लिए आर्ग्युमेंट (जैसे, "-f out.txt" में "out.txt") या विकल्प के अलावा पोज़िशनल आर्ग्युमेंट के तौर पर बांटा जाता है.

हर विकल्प के आर्ग्युमेंट को एक या उससे ज़्यादा Option फ़ील्ड पर मैप करना ज़रूरी है. एक बड़ा विकल्प, Option नाम से मैप हो जाता है और एक छोटा विकल्प, Option के छोटे नाम को मैप करता है. एक ही ऑब्जेक्ट में मौजूद सभी Option फ़ील्ड के हिसाब से, हर विकल्प का नाम और उसका छोटा नाम यूनीक होना चाहिए.

एक विकल्प वाले आर्ग्युमेंट को कई ऑब्जेक्ट में एक ही नाम वाले कई Option फ़ील्ड पर मैप किया जा सकता है. Option आर्ग्युमेंट को नेमस्पेस किया जा सकता है, ताकि किसी ऑब्जेक्ट के पूरे क्लास के नाम या OptionClass उपनाम की वैल्यू का इस्तेमाल करके, किसी एक ऑब्जेक्ट में Option फ़ील्ड को यूनीक तरीके से रेफ़र किया जा सके. इसके लिए, ':' से अलग किया जाता है. उदाहरण के लिए,

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

छोटा विकल्प, "-" के बाद छोटा विकल्प वर्ण होता है. अगर विकल्प के लिए आर्ग्युमेंट की ज़रूरत है (जो कि किसी भी ग़ैर-बूलियन विकल्प के लिए सही है), तो इसे अलग पैरामीटर के तौर पर लिखा जा सकता है. हालांकि, ऐसा करना ज़रूरी नहीं है. इसका मतलब है कि "-f out.txt" और "-fout.txt", दोनों स्वीकार किए जाते हैं.

एक "-" के बाद, कई छोटे विकल्प दिए जा सकते हैं. हालांकि, ऐसा तब ही किया जा सकता है, जब सभी विकल्पों के लिए आर्ग्युमेंट की ज़रूरत न हो. आखिरी विकल्प के लिए आर्ग्युमेंट की ज़रूरत हो सकती है.

लंबा विकल्प "--" से शुरू होता है. इसके बाद, कई वर्ण होते हैं. अगर विकल्प के लिए आर्ग्युमेंट की ज़रूरत है, तो उसे विकल्प के नाम के बाद लिखा जा सकता है. इसके लिए, "=" का इस्तेमाल करें या अगले आर्ग्युमेंट के तौर पर लिखें. (जैसे, "--file=out.txt" या "--file out.txt".)

बूलियन लॉन्ग विकल्प '--name' को अपने-आप '--no-name' कंपैनियन मिल जाता है. "--flag" विकल्प दिया गया है, तो "--flag", "--no-flag", "--flag=true", और "--flag=false" सभी मान्य हैं. हालांकि, "--flag true" और "--flag false", दोनों का इस्तेमाल नहीं किया जा सकता. ऐसा इसलिए है, क्योंकि "--flag" अपने-आप काफ़ी है. इसके बाद, "true" या "false" का अलग से इस्तेमाल किया जाता है. "सही" और "गलत" के लिए समानार्थी शब्दों के तौर पर, "हां" और "नहीं" का इस्तेमाल किया जा सकता है.

"-" से शुरू न होने वाली और किसी पिछले विकल्प का ज़रूरी आर्ग्युमेंट न होने वाली हर स्ट्रिंग, विकल्प के बजाय पोज़िशनल आर्ग्युमेंट होती है. इसके बाद की सभी स्ट्रिंग भी पोज़िशनल आर्ग्युमेंट होती हैं. "--" के बाद मौजूद हर स्ट्रिंग, एक ऐसा आर्ग्युमेंट होता है जिसे विकल्प के तौर पर नहीं चुना जा सकता.

विकल्पों को प्रोसेस करने के बाद, उनसे जुड़े फ़ील्ड अपडेट हो जाते हैं. बाकी बचे किसी भी पोज़िशनल आर्ग्युमेंट को List<String> के तौर पर दिखाया जाता है.

यहां एक आसान उदाहरण दिया गया है:

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

 }

 

• गेटऑप्ट(1) मैन पेज
• Python का "optparse" मॉड्यूल (http://docs.python.org/library/optparse.html)
• POSIX "यूटिलिटी सिंटैक्स दिशा-निर्देश" (http://www.opengroup.org/onlinepubs/000095399/BASEefs/xbd_chap12.html#tag_12_02)
• GNU "कमांड लाइन इंटरफ़ेस के लिए मानक" (http://www.gnu.org/prep/standards/standards.html#Command_002dLine-Interfaces)

खास जानकारी

सार्वजनिक कंस्ट्रक्टर

public ArgsOptionParser ( optionSources)

public ArgsOptionParser (Object... optionSources)

सार्वजनिक तरीके

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