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