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 () 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 esta opção. |
boolean | requiredForRerun () Se a opção é necessária para compilar instruções para executar novamente um teste. |
char | shortName () Nome abreviado opcional para 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 amigável da opção.
Devoluções | |
---|---|
String |
importância
public Option.Importance importance ()
A importância da opção.
Uma opção considerada 'importante' será exibida na saída de ajuda abreviada. A ajuda para uma opção sem importância só será exibida no texto de ajuda completo.Devoluções | |
---|---|
Option.Importance |
isTimeVal
public boolean isTimeVal ()
Se a opção representa um valor de tempo.
Se este for um valor de tempo, os sufixos específicos de tempo serão analisados. O campolong
ou Long
para que este sinalizador seja válido. Caso contrário, uma ConfigurationException
será lançada.
A unidade padrão é milis. A estrutura de configuração aceitará s
para segundos (1000 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 estejam listadas em ordem decrescente de escala. Assim, por exemplo, h
só pode aparecer antes m
e só pode aparecer 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.
Devoluções | |
---|---|
boolean |
obrigatório
public boolean mandatory ()
Se a opção é obrigatória ou opcional.
A estrutura de configuração lançará umaConfigurationException
se uma das seguintes opções for verdadeira em um campo obrigatório após as opções terem sido analisadas de todas as fontes:- O campo é
null
. - O campo é um
ERROR(/Collection)
vazio.
Devoluções | |
---|---|
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, umaOption
com o nome 'help' seria especificada com '--help' na linha de comando. Os nomes não podem conter dois pontos, por exemplo, ':'.Devoluções | |
---|---|
String |
obrigatórioParaReexecutar
public boolean requiredForRerun ()
Se a opção é necessária para compilar instruções para executar novamente um teste.
O relator do resultado pode tentar compilar instruções sobre como executar novamente um teste e incluir a mensagem no resultado. A instrução deve incluir todas as opções aplicáveis a uma nova execução de teste. Este atributo é utilizado para indicar se a opção deve ser incluída em tal instrução.
Devoluções | |
---|---|
boolean |
nome curto
public char shortName ()
Nome abreviado opcional para opção. Isso será mapeado para um argumento de linha de comando prefixado com um único '-'. por exemplo, "-h" onde h = shortName. '0' é reservado para significar que a opção não possui shortName.
Devoluções | |
---|---|
char |
regra de atualização
public OptionUpdateRule updateRule ()
Controla o comportamento quando uma opção é especificada várias vezes. Observe que esta regra é completamente ignorada para opções que são ERROR(/Collection)
s ou ERROR(/Map)
s.
Devoluções | |
---|---|
OptionUpdateRule |