Opción
public
abstract
@interface
Option
implements
Annotation
| com.android.tradefed.config.Option |
Anota un campo como representante de una opción IConfiguration.
Resumen
Constantes | |
|---|---|
char |
NO_SHORT_NAME
|
Métodos públicos | |
|---|---|
String
|
description()
Es una descripción fácil de usar de la opción. |
Option.Importance
|
importance()
La importancia de la opción. |
boolean
|
isTimeVal()
Indica si la opción representa un valor de tiempo. |
boolean
|
mandatory()
Indica si la opción es obligatoria o opcional. |
String
|
name()
Es el nombre único obligatorio para esta opción. |
boolean
|
requiredForRerun()
Si se necesita la opción para compilar instrucciones a fin de volver a ejecutar una prueba. |
char
|
shortName()
Es el nombre abreviado opcional de la opción. |
OptionUpdateRule
|
updateRule()
Controla el comportamiento cuando una opción se especifica varias veces. |
Constantes
NO_SHORT_NAME
public static final char NO_SHORT_NAME
Valor constante: 48 (0x00000030)
Métodos públicos
descripción
public String description ()
Es una descripción fácil de usar de la opción.
| Muestra | |
|---|---|
String |
|
importancia
public Option.Importance importance ()
La importancia de la opción.
En el resultado de ayuda abreviado, se mostrará una opción considerada "importante". La ayuda para una opción poco importante solo se mostrará en el texto de ayuda completo.
| Muestra | |
|---|---|
Option.Importance |
|
isTimeVal
public boolean isTimeVal ()
Indica si la opción representa un valor de tiempo.
Si este es un valor de tiempo, se analizarán los sufijos específicos de tiempo. El campo long o Long para que esta marca sea válida. De lo contrario, se arrojará un ConfigurationException.
La unidad predeterminada es milisegundos. El framework de configuración aceptará s para segundos (1,000 milisegundos), m para minutos (60 segundos), h para horas (60 minutos) o d para días (24 horas).
Las unidades se pueden mezclar y combinar, siempre que cada una aparezca una vez como máximo y que todas las unidades que aparezcan se enumeren en orden decreciente de escala. Por ejemplo, es posible que h solo aparezca antes de m y después de d. Como ejemplo
específico, "1d2h3m4s5ms" sería un valor de tiempo válido, al igual que "4" o "4 ms". Se descartan todos los espacios en blanco incorporados.
| Muestra | |
|---|---|
boolean |
|
obligatorio
public boolean mandatory ()
Indica si la opción es obligatoria o opcional.
El framework de configuración arrojará un ConfigurationException si se cumple alguna de las siguientes condiciones en un campo obligatorio después de que se hayan analizado las opciones de todas las fuentes:
- El campo es
null. - El campo es un
ERROR(/Collection)vacío.
| Muestra | |
|---|---|
boolean |
|
nombre
public String name ()
El nombre único obligatorio para esta opción.
Esto se asignará a un argumento de línea de comandos con el prefijo de dos caracteres "-".
Por ejemplo, un Option con el nombre "help" se especificaría con "--help" en la línea de comandos.
Los nombres no pueden contener dos puntos, p. ej., ':'.
| Muestra | |
|---|---|
String |
|
requiredForRerun
public boolean requiredForRerun ()
Si se necesita la opción para compilar instrucciones a fin de volver a ejecutar una prueba.
El generador de informes de resultados puede intentar compilar instrucciones para volver a ejecutar una prueba y, luego, incluir el mensaje en el resultado. La instrucción debe incluir todas las opciones que se apliquen a una nueva ejecución de la prueba. Este atributo se usa para indicar si la opción debe incluirse en esa instrucción.
| Muestra | |
|---|---|
boolean |
|
shortName
public char shortName ()
Es el nombre abreviado opcional de la opción. Esto se asignará a un argumento de línea de comandos con el prefijo "-". p.ej., "-h", donde h = shortName. "0" se reserva para indicar que la opción no tiene shortName.
| Muestra | |
|---|---|
char |
|
updateRule
public OptionUpdateRule updateRule ()
Controla el comportamiento cuando se especifica una opción varias veces. Ten en cuenta que esta regla se ignora por completo para las opciones que son ERROR(/Collection) o ERROR(/Map).
| Muestra | |
|---|---|
OptionUpdateRule |
|