Opción
public abstract @interface Option
implements Annotation
com.android.tradefed.config.Option |
Anota un campo que representa una opción de IConfiguration
.
Resumen
Clases anidadas | |
---|---|
enum | Option.Importance
|
Constantes | |
---|---|
char | NO_SHORT_NAME
|
Métodos públicos | |
---|---|
String | description () Descripción fácil de usar de la opción. |
Option.Importance | importance () La importancia de la opción. |
boolean | isTimeVal () Si la opción representa un valor de tiempo. |
boolean | mandatory () Si la opción es obligatoria u opcional. |
String | name () El nombre exclusivo obligatorio para esta opción. |
boolean | requiredForRerun () Si se necesita la opción para compilar instrucciones para 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 ()
Descripción fácil de usar de la opción.
Devoluciones | |
---|---|
String |
importancia
public Option.Importance importance ()
La importancia de la opción.
Una opción considerada "importante" se mostrará en la salida de ayuda abreviada. La ayuda para una opción sin importancia solo se mostrará en el texto de ayuda completo.Devoluciones | |
---|---|
Option.Importance |
isTimeVal
public boolean isTimeVal ()
Si la opción representa un valor de tiempo.
Si se trata de un valor de tiempo, se analizarán los sufijos específicos de tiempo. El campolong
o Long
para que esta bandera sea válida. De lo contrario, se lanzará una ConfigurationException
. La unidad predeterminada es milis. El marco de configuración aceptará s
por segundos (1000 milis), m
por minutos (60 segundos), h
por horas (60 minutos) d
por días (24 horas). Las unidades se pueden mezclar y combinar, siempre que cada unidad aparezca como máximo una vez, y siempre que todas las unidades que aparezcan se enumeren en orden decreciente de escala. Entonces, por ejemplo, h
solo puede aparecer antes de m
, y solo puede aparecer después de d
. Como ejemplo específico, "1d2h3m4s5ms" sería un valor de tiempo válido, al igual que "4" o "4ms". Se descartan todos los espacios en blanco incrustados.Devoluciones | |
---|---|
boolean |
obligatorio
public boolean mandatory ()
Si la opción es obligatoria u opcional.
El marco de configuración generará unaConfigurationException
si se cumple alguna de las siguientes condiciones 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íoERROR(/Collection)
.
Devoluciones | |
---|---|
boolean |
nombre
public String name ()
El nombre exclusivo obligatorio para esta opción.
Esto se asignará a un argumento de línea de comando con el prefijo de dos caracteres '-'. Por ejemplo, unaOption
con el nombre 'ayuda' se especificaría con '--help' en la línea de comando. Los nombres no pueden contener dos puntos, por ejemplo, ':'.Devoluciones | |
---|---|
String |
requiredForRerun
public boolean requiredForRerun ()
Si se necesita la opción para compilar instrucciones para volver a ejecutar una prueba.
El informador de resultados puede intentar compilar instrucciones sobre cómo volver a ejecutar una prueba e incluir el mensaje en el resultado. La instrucción debe incluir todas las opciones aplicables a la repetición de una prueba. Este atributo se utiliza para indicar si la opción se incluirá en dicha instrucción.
Devoluciones | |
---|---|
boolean |
nombre corto
public char shortName ()
Nombre abreviado opcional para la opción. Esto se asignará a un argumento de línea de comando con el prefijo '-'. por ejemplo, "-h" donde h = shortName. '0' está reservado para indicar que la opción no tiene nombre corto.
Devoluciones | |
---|---|
char |
updateRule
public OptionUpdateRule updateRule ()
Controla el comportamiento cuando una opción se especifica varias veces. Tenga en cuenta que esta regla se ignora por completo para las opciones que son ERROR(/Collection)
o ERROR(/Map)
.
Devoluciones | |
---|---|
OptionUpdateRule |
Content and code samples on this page are subject to the licenses described in the Content License. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2019-10-02 UTC.