Lựa chọn
public abstract @interface Option
implements Annotation
com.android.tradefed.config.Option |
Chú thích một trường đại diện cho tùy chọn IConfiguration
.
Bản tóm tắt
Hằng số | |
---|---|
char | NO_SHORT_NAME
|
Phương pháp công khai | |
---|---|
String | description () Mô tả thân thiện với người dùng về tùy chọn. |
Option.Importance | importance () Tầm quan trọng của quyền chọn. |
boolean | isTimeVal () Liệu tùy chọn có đại diện cho một giá trị thời gian hay không. |
boolean | mandatory () Cho dù tùy chọn là bắt buộc hay tùy chọn. |
String | name () Tên duy nhất bắt buộc cho tùy chọn này. |
boolean | requiredForRerun () Liệu có cần tùy chọn này để biên dịch hướng dẫn để chạy lại bài kiểm tra hay không. |
char | shortName () Tên viết tắt tùy chọn cho tùy chọn. |
OptionUpdateRule | updateRule () Kiểm soát hành vi khi một tùy chọn được chỉ định nhiều lần. |
Hằng số
KHÔNG_SHORT_NAME
public static final char NO_SHORT_NAME
Giá trị không đổi: 48 (0x00000030)
Phương pháp công khai
Sự miêu tả
public String description ()
Mô tả thân thiện với người dùng về tùy chọn.
Trả lại | |
---|---|
String |
tầm quan trọng
public Option.Importance importance ()
Tầm quan trọng của quyền chọn.
Một tùy chọn được coi là 'quan trọng' sẽ được hiển thị trong đầu ra trợ giúp viết tắt. Trợ giúp cho một tùy chọn không quan trọng sẽ chỉ được hiển thị trong văn bản trợ giúp đầy đủ.Trả lại | |
---|---|
Option.Importance |
isTimeVal
public boolean isTimeVal ()
Liệu tùy chọn có đại diện cho một giá trị thời gian hay không.
Nếu đây là giá trị thời gian, hậu tố theo thời gian cụ thể sẽ được phân tích cú pháp. Cánh đồnglong
hoặc Long
để cờ này hợp lệ. Ngược lại, ConfigurationException
sẽ được ném ra.
Đơn vị mặc định là millis. Khung cấu hình sẽ chấp nhận s
trong giây (1000 millis), m
trong phút (60 giây), h
trong giờ (60 phút) hoặc d
trong ngày (24 giờ).
Các đơn vị có thể được trộn lẫn và kết hợp, miễn là mỗi đơn vị xuất hiện nhiều nhất một lần và miễn là tất cả các đơn vị xuất hiện đều được liệt kê theo thứ tự tỷ lệ giảm dần. Vì vậy, ví dụ: h
chỉ có thể xuất hiện trước m
và chỉ có thể xuất hiện sau d
. Như một ví dụ cụ thể, "1d2h3m4s5ms" sẽ là giá trị thời gian hợp lệ, cũng như "4" hoặc "4ms". Tất cả khoảng trắng nhúng sẽ bị loại bỏ.
Trả lại | |
---|---|
boolean |
bắt buộc
public boolean mandatory ()
Cho dù tùy chọn là bắt buộc hay tùy chọn.
Khung cấu hình sẽ đưa raConfigurationException
nếu một trong hai điều sau đây đúng với trường bắt buộc sau khi các tùy chọn được phân tích cú pháp từ tất cả các nguồn:- Trường này là
null
. - Trường này trống
ERROR(/Collection)
.
Trả lại | |
---|---|
boolean |
tên
public String name ()
Tên duy nhất bắt buộc cho tùy chọn này.
Điều này sẽ ánh xạ tới một đối số dòng lệnh có tiền tố là hai ký tự '-'. Ví dụ:Option
có tên 'help' sẽ được chỉ định bằng '--help' trên dòng lệnh. Tên không được chứa dấu hai chấm, ví dụ: ':'.Trả lại | |
---|---|
String |
bắt buộcForChạy lại
public boolean requiredForRerun ()
Liệu có cần tùy chọn này để biên dịch hướng dẫn để chạy lại bài kiểm tra hay không.
Trình báo cáo kết quả có thể cố gắng biên soạn hướng dẫn về cách chạy lại xét nghiệm và đưa thông báo vào kết quả. Hướng dẫn phải bao gồm tất cả các tùy chọn áp dụng cho việc chạy lại thử nghiệm. Thuộc tính này được sử dụng để cho biết liệu tùy chọn có được đưa vào lệnh đó hay không.
Trả lại | |
---|---|
boolean |
tên ngắn
public char shortName ()
Tên viết tắt tùy chọn cho tùy chọn. Điều này sẽ ánh xạ tới một đối số dòng lệnh có tiền tố là một '-'. ví dụ: "-h" trong đó h = shortName. '0' được dành riêng có nghĩa là tùy chọn không có shortName.
Trả lại | |
---|---|
char |
cập nhậtRule
public OptionUpdateRule updateRule ()
Kiểm soát hành vi khi một tùy chọn được chỉ định nhiều lần. Lưu ý rằng quy tắc này bị bỏ qua hoàn toàn đối với các tùy chọn là ERROR(/Collection)
s hoặc ERROR(/Map)
s.
Trả lại | |
---|---|
OptionUpdateRule |