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 fácil de usar da opção. |
Option.Importance
|
importance()
A importância da opção. |
boolean
|
isTimeVal()
Se a opção representa um valor de tempo. |
boolean
|
mandatory()
Indica se a opção é obrigatória ou opcional. |
String
|
name()
O nome exclusivo obrigatório para esta opção. |
boolean
|
requiredForRerun()
Se a opção é necessária para compilar instruções para executar um teste novamente. |
char
|
shortName()
Nome abreviado opcional para a 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 constante: 48 (0x00000030)
Métodos públicos
descrição
public String description ()
Descrição fácil de usar da opção.
| Retorna | |
|---|---|
String |
|
importância
public Option.Importance importance ()
A importância da opção.
Uma opção considerada "importante" será exibido na saída de ajuda abreviada. Ajuda para um a opção sem importância será exibida somente no texto de ajuda completo.
| Retorna | |
|---|---|
Option.Importance |
|
isTimeVal
public boolean isTimeVal ()
Se a opção representa um valor de tempo.
Se for um valor temporal, os sufixos específicos de horário serão analisados. O campo
long ou Long para que essa flag seja válida. Caso contrário, uma ConfigurationException será gerada.
A unidade padrão é milissegundos. O framework de configuração vai aceitar s por segundos
(1.000 milissegundos), m para minutos (60 segundos), h para horas (60 minutos) ou
d para dias (24 horas).
As unidades podem ser combinadas, contanto que cada uma apareça no máximo uma vez e contanto que
todas as unidades que aparecem são listadas em ordem decrescente de escala. Por exemplo, h pode aparecer somente antes de m e depois de d. Como um objeto específico
exemplo, "1d2h3m4s5ms" seria um valor de tempo válido, como "4" ou "4 ms". Todos incorporados
o espaço em branco é descartado.
| Retorna | |
|---|---|
boolean |
|
obrigatório
public boolean mandatory ()
Indica se a opção é obrigatória ou opcional.
O framework de configuração vai gerar uma ConfigurationException se um dos
a seguir é verdadeiro para um campo obrigatório depois que as opções forem analisadas de todas as origens:
- O campo é
null. - O campo é uma
ERROR(/Collection)vazia.
| Retorna | |
|---|---|
boolean |
|
nome
public String name ()
O nome exclusivo obrigatório para esta opção.
Isso será mapeado para um argumento de linha de comando prefixado com dois "-" caracteres.
Por exemplo, uma Option com o nome "help". é especificado com "--help" no(a)
linha de comando.
Os nomes não podem conter dois-pontos, por exemplo, ":".
| Retorna | |
|---|---|
String |
|
requiredForRerun
public boolean requiredForRerun ()
Se a opção é necessária para compilar instruções para executar um teste novamente.
O informante de resultados pode tentar compilar instruções sobre como executar novamente um teste e incluir as no resultado. A instrução precisa incluir todas as opções aplicáveis a um teste executar novamente. Esse atributo é usado para indicar se a opção deve ser incluída em instrução.
| Retorna | |
|---|---|
boolean |
|
Apelido
public char shortName ()
Nome abreviado opcional para a opção. Isso será mapeado para um argumento de linha de comando prefixado com um único "-". Por exemplo: "-h" em que h = shortName. "0" está reservado para significar 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. Observe que esta regra é
ignoradas completamente para opções que sejam ERROR(/Collection)s ou ERROR(/Map)s.
| Retorna | |
|---|---|
OptionUpdateRule |
|