Вариант
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
. - Поле является пустым
ERROR(/Collection)
.
Возвращает | |
---|---|
boolean |
имя
public String name ()
Обязательное уникальное имя для этой опции.
Это будет отображаться в аргумент командной строки с префиксом из двух символов «-». Например,Option
с именем «help» будет указана с помощью «--help» в командной строке. Имена не могут содержать двоеточие, например ':'.Возвращает | |
---|---|
String |
requiredForRerun
public boolean requiredForRerun ()
Нужна ли опция для компиляции инструкции для повторного запуска теста.
Отчет о результатах может попытаться составить инструкцию о том, как повторно запустить тест, и включить сообщение в результат. Инструкция должна включать все опции, применимые к повторному запуску теста. Этот атрибут используется, чтобы указать, должна ли опция быть включена в такую инструкцию.
Возвращает | |
---|---|
boolean |
короткое имя
public char shortName ()
Необязательное сокращенное название опции. Это будет сопоставлено с аргументом командной строки с префиксом «-». например "-h", где h = короткое имя. '0' зарезервирован для обозначения того, что опция не имеет ShortName.
Возвращает | |
---|---|
char |
updateRule
public OptionUpdateRule updateRule ()
Управляет поведением, когда параметр указан несколько раз. Обратите внимание, что это правило полностью игнорируется для параметров, которые являются ERROR(/Collection)
s или ERROR(/Map)
s.
Возвращает | |
---|---|
OptionUpdateRule |