ArgsOption Parser

public class ArgsOptionParser
extends OptionSetter

เติมฟิลด์ Option จากอาร์กิวเมนต์บรรทัดคำสั่งที่แยกวิเคราะห์

สตริงใน String[] ที่ผ่านเข้ามาจะถูกแยกวิเคราะห์จากซ้ายไปขวา แต่ละสตริงถูกจัดประเภทเป็นตัวเลือกแบบสั้น (เช่น "-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")

ตัวเลือกบูลีนแบบยาว '--name' จะได้รับการแสดงร่วม '--no-name' โดยอัตโนมัติ เมื่อพิจารณาตัวเลือก "--flag" ดังนั้น "--flag", "--no-flag", "--flag=true" และ "--flag=false" จึงใช้ได้ทั้งหมด แม้ว่าจะไม่มี "--flag" จริง" หรือ "--flag เท็จ" ได้รับอนุญาต (เนื่องจาก "--flag" เพียงอย่างเดียวก็เพียงพอแล้ว "จริง" หรือ "เท็จ" ต่อไปนี้จึงถูกตีความแยกกัน) คุณสามารถใช้ "ใช่" และ "ไม่" เป็นคำพ้องความหมายสำหรับ "จริง" และ "เท็จ"

แต่ละสตริงที่ไม่ได้ขึ้นต้นด้วย "-" และไม่ใช่อาร์กิวเมนต์ที่จำเป็นสำหรับตัวเลือกก่อนหน้าคืออาร์กิวเมนต์ตำแหน่งที่ไม่ใช่ตัวเลือก เช่นเดียวกับสตริงที่ต่อเนื่องกันทั้งหมด แต่ละสตริงหลัง "--" เป็นอาร์กิวเมนต์ระบุตำแหน่งที่ไม่ใช่ตัวเลือก

ฟิลด์ที่เกี่ยวข้องกับตัวเลือกจะได้รับการอัปเดตเมื่อตัวเลือกถูกประมวลผล อาร์กิวเมนต์ตำแหน่งที่เหลืออยู่จะถูกส่งกลับเป็นรายการ<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" ของ Python (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 ()