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.
 

الخيار القصير البسيط هو "-" متبوعًا بحرف خيار قصير. إذا كان الخيار يتطلب وسيطة (وهو ما ينطبق على أي خيار غير منطقي)، فقد يتم كتابته كمعلمة منفصلة، ​​ولكن ليس من الضروري أن يكون كذلك. وهذا يعني أن "-fout.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" في حد ذاته يكفي، يتم تفسير "صحيح" أو "خطأ" التالي بشكل منفصل). يمكنك استخدام "نعم" و"لا" كمرادفات لـ "صحيح" و"خطأ".

كل سلسلة لا تبدأ بـ "-" وليست وسيطة مطلوبة لخيار سابق هي وسيطة موضعية غير خيارية، كما هو الحال مع جميع السلاسل المتعاقبة. كل سلسلة بعد "--" هي وسيطة موضعية غير اختيارية.

يتم تحديث الحقول المقابلة للخيارات أثناء معالجة خياراتها. يتم إرجاع أي وسيطات موضعية متبقية كقائمة <سلسلة>.

إليك مثال بسيط:

 // 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)
• "معايير واجهات سطر الأوامر" 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 ()