تجزیه‌گر گزینه آرگ‌ها

public class ArgsOptionParser
extends OptionSetter

فیلدهای Option را از آرگومان‌های خط فرمان تجزیه‌شده پر می‌کند.

رشته‌های موجود در String[] ارسالی از چپ به راست تجزیه می‌شوند. هر رشته به عنوان یک گزینه کوتاه (مانند "-v")، یک گزینه بلند (مانند "--verbose")، یک آرگومان برای یک گزینه (مانند "out.txt" در "-f out.txt") یا یک آرگومان موقعیتی بدون گزینه طبقه‌بندی می‌شود.

هر آرگومان option باید به یک یا چند فیلد Option نگاشت شود. یک option طولانی به نام Option و یک option کوتاه به نام Option کوتاه نگاشت می‌شود. هر نام 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" زیر به طور جداگانه تفسیر می‌شود). می‌توانید از "yes" و "no" به عنوان مترادف "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) {
        ...
     }
     ...

 }

 

• صفحه راهنمای getopt(1)
• ماژول "optparse" پایتون (http://docs.python.org/library/optparse.html)
• «دستورالعمل‌های نحوی سودمند» POSIX (http://www.opengroup.org/onlinepubs/000095399/basedefs/xbd_chap12.html#tag_12_02)
• «استانداردهای رابط‌های خط فرمان» گنو (http://www.gnu.org/prep/standards/standards.html#Command_002dLine-Interfaces)

خلاصه

سازندگان عمومی

public ArgsOptionParser (Object... optionSources)

public ArgsOptionParser (Collection<Object> optionSources)

روش‌های عمومی

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