Вариант
public abstract @interface Option
implements Annotation
| com.android.tradefed.config.Option |
Добавляет аннотацию к полю, указывая, что оно представляет собой параметр IConfiguration .
Краткое содержание
Константы | |
|---|---|
char | NO_SHORT_NAME |
Общедоступные методы | |
|---|---|
String | description ()Удобное для пользователя описание опции. |
Option.Importance | importance ()Важность этой опции. |
boolean | isTimeVal ()Представляет ли собой опцион временную стоимость. |
boolean | mandatory ()Является ли этот вариант обязательным или необязательным. |
String | name ()Обязательное уникальное имя для этой опции. |
boolean | requiredForRerun ()Необходимо ли наличие этой опции для компиляции инструкции по повторному запуску теста. |
char | shortName ()Дополнительное сокращенное название для параметра. |
OptionUpdateRule | updateRule ()Управляет поведением при многократном указании параметра. |
Константы
NO_SHORT_NAME
public static final char NO_SHORT_NAME
Постоянное значение: 48 (0x00000030)
Общедоступные методы
описание
public String description ()
Удобное для пользователя описание опции.
| Возвраты | |
|---|---|
String | |
важность
public Option.Importance importance ()
Важность этой опции.
Опция, помеченная как «важная», будет отображена в сокращенном виде справки. Справка по неважной опции будет отображена только в полном тексте справки.| Возвраты | |
|---|---|
Option.Importance | |
isTimeVal
public boolean isTimeVal ()
Представляет ли собой опцион временную стоимость.
Если это значение времени, будут проанализированы суффиксы, относящиеся к конкретному времени. Полеlong или Long . В противном случае будет выброшено исключение ConfigurationException .
Единица измерения по умолчанию — миллисекунды. Система конфигурации принимает значения: s для секунд (1000 миллисекунд), m для минут (60 секунд), h для часов (60 минут) или d для дней (24 часа).
Единицы измерения можно комбинировать, при условии, что каждая единица встречается не более одного раза и все встречающиеся единицы указаны в порядке убывания шкалы. Например, h может встречаться только перед m , а после d . В качестве конкретного примера, "1d2h3m4s5ms" будет допустимым значением времени, как и "4" или "4ms". Все пробелы внутри значения отбрасываются.
| Возвраты | |
|---|---|
boolean | |
обязательный
public boolean mandatory ()
Является ли этот вариант обязательным или необязательным.
Система конфигурации выдаст исключениеConfigurationException если после анализа параметров из всех источников для обязательного поля выполняется хотя бы одно из следующих условий:- Поле
null. - Поле представляет собой пустую
Collection.
| Возвраты | |
|---|---|
boolean | |
имя
public String name ()
Обязательное уникальное имя для этой опции.
Это будет соответствовать аргументу командной строки, перед которым стоят два символа '-'. Например,Option с именем 'help' будет указан как '--help' в командной строке. В именах не должно быть двоеточия, например, ':'.| Возвраты | |
|---|---|
String | |
requiredForRerun
public boolean requiredForRerun ()
Необходимо ли наличие этой опции для компиляции инструкции по повторному запуску теста.
Создатель отчета о результатах может попытаться составить инструкцию по повторному запуску теста и включить сообщение в результат. Инструкция должна включать все параметры, применимые к повторному запуску теста. Этот атрибут используется для указания того, следует ли включать параметр в такую инструкцию.
| Возвраты | |
|---|---|
boolean | |
короткое имя
public char shortName ()
Необязательное сокращенное имя для параметра. Оно будет соответствовать аргументу командной строки с префиксом '-'. Например, "-h", где h = shortName. '0' зарезервировано для обозначения отсутствия у параметра shortName.
| Возвраты | |
|---|---|
char | |
updateRule
public OptionUpdateRule updateRule ()
Управляет поведением при многократном указании параметра. Обратите внимание, что это правило полностью игнорируется для параметров, являющихся Collection или Map .
| Возвраты | |
|---|---|
OptionUpdateRule | |