ArgsOptionParser

public class ArgsOptionParser
extends OptionSetter

Điền các trường Option từ các đối số dòng lệnh đã phân tích cú pháp.

Các chuỗi trong Chuỗi truyền vào[] được phân tích cú pháp từ trái sang phải. Mỗi Chuỗi được phân loại là một tuỳ chọn ngắn (chẳng hạn như "-v"), một tuỳ chọn dài (chẳng hạn như "--verbose"), một đối số cho một tuỳ chọn (chẳng hạn như "out.txt" trong "-f out.txt") hoặc một đối số vị trí không phải tuỳ chọn.

Mỗi đối số tuỳ chọn phải liên kết với một hoặc nhiều trường Option. Tuỳ chọn dài liên kết với tên Option, còn tuỳ chọn ngắn liên kết với tên ngắn Option. Mỗi tên tuỳ chọn và tên ngắn của tuỳ chọn phải là duy nhất so với tất cả các trường Option khác trong cùng một đối tượng.

Một đối số tuỳ chọn có thể được liên kết đến nhiều trường Option có cùng tên trên nhiều đối tượng. Bạn có thể đặt tên không gian cho đối số Option để tham chiếu duy nhất đến một trường Option trong một đối tượng bằng cách sử dụng tên lớp đầy đủ của đối tượng đó hoặc giá trị bí danh OptionClass được phân tách bằng dấu ":". Ví dụ:

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

Tuỳ chọn ngắn đơn giản là dấu "-" theo sau là một ký tự tuỳ chọn ngắn. Nếu tuỳ chọn yêu cầu một đối số (đúng với mọi tuỳ chọn không phải boolean), thì tuỳ chọn đó có thể được viết dưới dạng một tham số riêng biệt, nhưng không bắt buộc. Tức là cả "-f out.txt" và "-fout.txt" đều được chấp nhận.

Bạn có thể chỉ định nhiều tuỳ chọn ngắn sau một dấu "-" nếu tất cả (ngoại trừ có thể là lựa chọn cuối cùng) không cần đối số.

Một lựa chọn dài bắt đầu bằng "--", theo sau là một vài ký tự. Nếu tuỳ chọn yêu cầu một đối số, bạn có thể viết đối số đó ngay sau tên tuỳ chọn, phân tách bằng dấu "=" hoặc dưới dạng đối số tiếp theo. (Tức là "--file=out.txt" hoặc "--file out.txt".)

Tuỳ chọn boolean dài "--name" sẽ tự động nhận được một tuỳ chọn đồng hành "--no-name". Với tuỳ chọn "--flag", thì "--flag", "--no-flag", "--flag=true" và "--flag=false" đều hợp lệ, mặc dù không cho phép "--flag true" hoặc "--flag false" (vì "--flag" là đủ, "true" hoặc "false" sau đây được diễn giải riêng). Bạn có thể sử dụng "yes" và "no" làm từ đồng nghĩa cho "true" và "false".

Mỗi Chuỗi không bắt đầu bằng dấu "-" và không phải là đối số bắt buộc của một tuỳ chọn trước đó đều là đối số vị trí không phải tuỳ chọn, cũng như tất cả các Chuỗi tiếp theo. Mỗi Chuỗi sau dấu "--" là một đối số vị trí không phải là tuỳ chọn.

Các trường tương ứng với các tuỳ chọn sẽ được cập nhật khi các tuỳ chọn đó được xử lý. Mọi đối số vị trí còn lại đều được trả về dưới dạng List<String>.

Sau đây là một ví dụ đơn giản:

 // 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) {
        ...
     }
     ...

 }

 

• trang man getopt(1)
• Mô-đun "optparse" của Python (http://docs.python.org/library/optparse.html)
• "Nguyên tắc cú pháp tiện ích" của POSIX (http://www.opengroup.org/onlinepubs/000095399/basedefs/xbd_chap12.html#tag_12_02)
• "Tiêu chuẩn cho giao diện dòng lệnh" của GNU (http://www.gnu.org/prep/standards/standards.html#Command_002dLine-Interfaces)

Tóm tắt

Hàm khởi tạo công khai

public ArgsOptionParser ( optionSources)

public ArgsOptionParser (Object... optionSources)

Phương thức công khai

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