Opção

public abstract @interface Option
implements Annotation

com.android.tradefed.config.Option


Anota um campo como representando uma opção IConfiguration.

Resumo

Constantes

char NO_SHORT_NAME

Métodos públicos

String description()

Descrição amigável da opção.

Option.Importance importance()

A importância da opção.

boolean isTimeVal()

Indica se a opção representa um valor de tempo.

boolean mandatory()

Se a opção é obrigatória ou opcional.

String name()

O nome exclusivo obrigatório para essa opção.

boolean requiredForRerun()

Indica se a opção é necessária para compilar instruções para executar novamente um teste.

char shortName()

Nome abreviado opcional da opção.

OptionUpdateRule updateRule()

Controla o comportamento quando uma opção é especificada várias vezes.

Constantes

NO_SHORT_NAME

public static final char NO_SHORT_NAME

Valor da constante: 48 (0x00000030)

Métodos públicos

descrição

public String description ()

Descrição amigável da opção.

Retorna
String

importância

public Option.Importance importance ()

A importância da opção.

Uma opção considerada "importante" vai aparecer na saída de ajuda abreviada. A ajuda para uma opção sem importância só será exibida no texto de ajuda completo.

Retorna
Option.Importance

isTimeVal

public boolean isTimeVal ()

Indica se a opção representa um valor de tempo.

Se for um valor de tempo, os sufixos específicos de tempo serão analisados. O campo PRECISA ser long ou Long para que essa sinalização seja válida. Caso contrário, uma ConfigurationException será gerada.

A unidade padrão é milissegundos. O framework de configuração aceitará s para segundos (1.000 milissegundos), m para minutos (60 segundos), h para horas (60 minutos) ou d para dias (24 horas).

As unidades podem ser misturadas e combinadas, desde que cada unidade apareça no máximo uma vez e desde que todas as unidades que aparecem sejam listadas em ordem decrescente de escala. Por exemplo, h só pode aparecer antes de m e depois de d. Como exemplo específico, "1d2h3m4s5ms" seria um valor de tempo válido, assim como "4" ou "4ms". Todos os espaços em branco incorporados são descartados.

Retorna
boolean

obrigatório

public boolean mandatory ()

Se a opção é obrigatória ou opcional.

O framework de configuração vai gerar uma ConfigurationException se uma das seguintes condições for verdadeira para um campo obrigatório depois que as opções tiverem sido analisadas de todas as origens:

Retorna
boolean

nome

public String name ()

O nome exclusivo obrigatório para essa opção.

Isso será associado a um argumento de linha de comando com prefixo de dois caracteres "-". Por exemplo, uma Option com o nome 'help' seria especificada com '--help' na linha de comando.

Os nomes não podem conter dois-pontos, por exemplo, ":".

Retorna
String

requiredForRerun

public boolean requiredForRerun ()

Indica se a opção é necessária para compilar instruções para executar novamente um teste.

O relatório de resultados pode tentar compilar instruções sobre como repetir um teste e incluir a mensagem no resultado. A instrução deve incluir todas as opções aplicáveis a uma nova execução do teste. Esse atributo é usado para indicar se a opção será incluída nessa instrução.

Retorna
boolean

Apelido

public char shortName ()

Nome abreviado opcional da opção. Isso será mapeado para um argumento de linha de comando com um prefixo de um único "-". Por exemplo, "-h", em que h = shortName. "0" significa que a opção não tem shortName.

Retorna
char

updateRule

public OptionUpdateRule updateRule ()

Controla o comportamento quando uma opção é especificada várias vezes. Essa regra é ignorada completamente para opções que são ERROR(/Collection)s ou ERROR(/Map)s.

Retorna
OptionUpdateRule