ArgsOptionParser

public class ArgsOptionParser
extends OptionSetter

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

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

هر آرگومان گزینه باید به یک یا چند نقشه Option زمینه. گزینه طولانی نقشه به Option نام، و یک گزینه کوتاه نقشه ها را به Option نام کوتاه. هر نام گزینه و نام کوتاه گزینه باید منحصر به فرد با توجه به تمام دیگر Option زمینه در همان جسم.

بحث گزینه تنها می توانید به چند نقشه برداری Option زمینه با همین نام در سراسر اشیاء متعدد. Option استدلال می توان فضای نام منحصر به فرد به یک اشاره Option درست در یک شی تنها با استفاده از نام کلاس کامل است که جسم و یا آن OptionClass ارزش نام مستعار هم جدا شده توسط ':'. یعنی

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

یک گزینه کوتاه ساده یک "-" است که پس از آن یک کاراکتر گزینه کوتاه وجود دارد. اگر گزینه به یک آرگومان نیاز دارد (که در مورد هر گزینه غیر بولی صادق است) ، ممکن است به عنوان یک پارامتر جداگانه نوشته شود ، اما نیازی به آن نیست. یعنی "-f out.txt" و "-fout.txt" هر دو قابل قبول هستند.

این امکان وجود دارد که چندین گزینه کوتاه را پس از یک "-" واحد مشخص کنید تا زمانی که همه (به جز احتمالاً آخرین) نیازی به آرگومان ندارند.

یک گزینه طولانی با "-" و به دنبال چندین کاراکتر شروع می شود. اگر گزینه به آرگومان نیاز دارد ، ممکن است مستقیماً بعد از نام گزینه ، با "=" جدا شده یا به عنوان آرگومان بعدی نوشته شود. (یعنی "--file = out.txt" یا "--file out.txt".)

یک گزینه طولانی boolean '--name' به طور خودکار یک همراه '-no-name' دریافت می کند. با انتخاب گزینه "--flag" ، سپس ، "--flag" ، "--no-flag" ، "--flag = true" و "--flag = false" همه معتبر هستند ، گرچه هیچ کدام "--flag true "nor" --flag false "مجاز است (از آنجا که" --flag "به تنهایی کافی است ،" درست "یا" غلط "زیر به طور جداگانه تفسیر می شود). شما می توانید از "بله" و "نه" به عنوان مترادف "درست" و "نادرست" استفاده کنید.

هر رشته ای که با یک "-" شروع نمی شود و یک آرگومان مورد نیاز یک گزینه قبلی نیست ، مانند همه رشته های متوالی ، یک آرگومان موقعیتی بدون گزینه است. هر رشته بعد از یک "-" یک آرگومان موقعیتی بدون گزینه است.

زمینه های مربوط به گزینه ها با پردازش گزینه های آنها به روز می شوند. هرگونه آرگومان موقعیتی باقی مانده به عنوان 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) {
        ...
     }
     ...

 }

 

• صفحه man getopt (1)
• ماژول "optparse" پایتون (http://docs.python.org/library/optparse.html)
• POSIX "دستورالعمل نحو مفید" (http://www.opengroup.org/onlinepubs/000095399/basedefs/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 ()