ArgsOptionParser

public class ArgsOptionParser
extends OptionSetter

يملأ حقول Option من وسيطات سطر الأوامر الموزعة.

يتم تحليل السلاسل الموجودة في السلسلة التي تم تمريرها من اليسار إلى اليمين. يتم تصنيف كل سلسلة على أنها خيار قصير (مثل "-v") ، وخيار طويل (مثل "- overbose") ، وسيطة لخيار (مثل "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".)

الخيار المنطقي الطويل "--name" يحصل تلقائيًا على رفيق "- no-name". إعطاء خيار "--flag" ، إذن ، "--flag" ، "- no-flag" ، "--flag = true" و "--flag = false" كلها صالحة ، على الرغم من عدم صلاحية "--flag" يُسمح باستخدام "true" أو "--flag false" (نظرًا لأن "--flag" يكفي بحد ذاته ، يتم تفسير "true" أو "false" التاليين بشكل منفصل). يمكنك استخدام "نعم" و "لا" كمرادفين لكل من "صواب" و "خطأ".

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

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

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

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