Opción

public abstract @interface Option
implements Annotation

com.android.tradefed.config.Option


Anota un campo como si representara una opción de 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()

Es 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()

Es el nombre único obligatorio para esta opción.

boolean requiredForRerun()

Indica si la opción es necesaria para compilar instrucciones para volver a ejecutar una prueba.

char shortName()

Nombre abreviado opcional para la opción.

OptionUpdateRule updateRule()

Controla el comportamiento cuando se especifica una opción 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 ()

Es la importancia de la opción.

Las opciones consideradas "importantes" se mostrarán en el resultado de ayuda abreviado. 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 se trata de un valor de tiempo, se analizarán los sufijos específicos del tiempo. El campo DEBE ser long o Long para que esta marca sea válida. De lo contrario, se arrojará un ConfigurationException.

La unidad predeterminada es millis. 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 combinar, siempre y cuando cada unidad aparezca como máximo una vez y todas las unidades que aparezcan se enumeren en orden decreciente de escala. Por ejemplo, h solo puede aparecer 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 "4ms". Se descartan todos los espacios en blanco incorporados.

Muestra
boolean

obligatorio

public boolean mandatory ()

Indica si la opción es obligatoria u opcional.

El framework de configuración arrojará un ConfigurationException si se cumple alguna de las siguientes condiciones para un campo obligatorio después de que se hayan analizado las opciones de todas las fuentes:

  • El campo es null.
  • El campo es un Collection vacío.

Muestra
boolean

nombre

public String name ()

Es 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 ()

Indica si la opción es necesaria para compilar instrucciones para volver a ejecutar una prueba.

El reportero de resultados puede intentar compilar instrucciones sobre cómo volver a ejecutar una prueba y, luego, incluir el mensaje en el resultado. La instrucción debe incluir todas las opciones aplicables a una nueva ejecución de la prueba. Este atributo se usa para indicar si la opción se debe incluir en esa instrucción.

Muestra
boolean

shortName

public char shortName ()

Nombre abreviado opcional para la opción. Se asignará a un argumento de línea de comandos con el prefijo de un solo "-", p. ej., "-h", donde h = shortName. El valor "0" está reservado 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 Collection o Map.

Muestra
OptionUpdateRule