Opción
public
abstract
@interface
Option
implements
Annotation
com.android.tradefed.config.Option |
Anota un campo como que representa 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 u opcional. |
String
|
name()
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()
Nombre abreviado opcional para 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.
Una opción que se considera "importante" se mostrará en el resultado de ayuda abreviado. Ayuda para un la opción no 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á una ConfigurationException
.
La unidad predeterminada es milésimas de segundo. El framework de configuración aceptará s
por segundos
(1,000 milisegundos), m
para los minutos (60 segundos), h
para las horas (60 minutos) o
d
por días (24 horas).
Las unidades se pueden mezclar y combinar, siempre y cuando cada unidad aparezca como máximo una vez y siempre que
Todas las unidades que aparecen se enumeran en orden descendente de escala. Por ejemplo, es posible que h
solo aparezca antes de m
y después de d
. De forma específica,
ejemplo, "1d2h3m4s5ms" sería un valor de tiempo válido, al igual que "4" o “4 ms”. Todos los incorporados
espacio en blanco.
Muestra | |
---|---|
boolean |
obligatorio
public boolean mandatory ()
Indica si la opción es obligatoria u opcional.
El framework de configuración arrojará una ConfigurationException
si cualquiera de los
siguiente es verdadero de 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 dos “-” caracteres.
Por ejemplo, un elemento Option
con el nombre “help” se especificaría con “--help” en la
la línea de comandos.
Los nombres no pueden contener dos puntos; p. ej., “:”.
Muestra | |
---|---|
String |
requeridoParaVolver a ejecutar
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 sobre cómo volver a ejecutar una prueba e incluir el mensaje en el resultado. La instrucción deberá incluir todas las opciones aplicables a una prueba volver a ejecutar. Este atributo se utiliza para indicar si la opción debe incluirse en tales instrucciones.
Muestra | |
---|---|
boolean |
NombreCorto
public char shortName ()
Nombre abreviado opcional para la opción. Esto se asignará a un argumento de línea de comandos con el prefijo único "-". p.ej., “-h” donde h = shortName. "0" está reservado para significar que la opción no tiene shortName.
Muestra | |
---|---|
char |
Regla actualizar
public OptionUpdateRule updateRule ()
Controla el comportamiento cuando una opción se especifica varias veces. Ten en cuenta que esta regla
Se ignora por completo para las opciones que son ERROR(/Collection)
o ERROR(/Map)
.
Muestra | |
---|---|
OptionUpdateRule |