Option
public
abstract
@interface
Option
implements
Annotation
com.android.tradefed.config.Option |
Annote un champ comme représentant une option IConfiguration
.
Résumé
Constantes | |
---|---|
char |
NO_SHORT_NAME
|
Méthodes publiques | |
---|---|
String
|
description()
Description conviviale de l'option. |
Option.Importance
|
importance()
Importance de l'option. |
boolean
|
isTimeVal()
Indique si l'option représente une valeur temporelle. |
boolean
|
mandatory()
Indique si l'option est obligatoire ou facultative. |
String
|
name()
Nom unique obligatoire pour cette option. |
boolean
|
requiredForRerun()
Indique si l'option est nécessaire pour compiler une instruction afin de réexécuter un test. |
char
|
shortName()
Nom abrégé facultatif pour l'option. |
OptionUpdateRule
|
updateRule()
Contrôle le comportement lorsqu'une option est spécifiée plusieurs fois. |
Constantes
NO_SHORT_NAME
public static final char NO_SHORT_NAME
Valeur constante: 48 ans (0x00000030)
Méthodes publiques
description
public String description ()
Description conviviale de l'option.
Renvoie | |
---|---|
String |
importance
public Option.Importance importance ()
Importance de l'option.
Une option considérée comme "importante" apparaît dans la version abrégée de l'aide. Aide concernant un l'option sans importance ne sera affichée que dans le texte d'aide complet.
Renvoie | |
---|---|
Option.Importance |
IsTimeVal
public boolean isTimeVal ()
Indique si l'option représente une valeur temporelle.
S'il s'agit d'une valeur temporelle, les suffixes temporels seront analysés. Champ
long
ou Long
pour que cet indicateur soit valide. Sinon, une exception ConfigurationException
est générée.
L'unité par défaut est le milliseconde. Le framework de configuration accepte s
pendant quelques secondes
(1 000 millisecondes), m
pour les minutes (60 secondes), h
pour les heures (60 minutes) ou
d
pour les jours (24 heures)
Les unités peuvent être mélangées et mises en correspondance, tant que chaque unité apparaît au maximum une fois et que
toutes les unités qui apparaissent sont listées par ordre décroissant d'échelle. Ainsi, par exemple, h
peut uniquement apparaître avant m
et après d
. Comme
Exemple : "1d2h3m4s5ms" est une valeur temporelle valide, comme "4" ou "4ms". Toutes les données intégrées
les espaces blancs sont supprimés.
Renvoie | |
---|---|
boolean |
obligatoire
public boolean mandatory ()
Indique si l'option est obligatoire ou facultative.
Le framework de configuration génère une erreur ConfigurationException
si l'une des
Ce qui suit s'applique à un champ obligatoire une fois que les options ont été analysées à partir de toutes les sources:
- Le champ est
null
. - Le champ est un
ERROR(/Collection)
vide.
Renvoie | |
---|---|
boolean |
nom
public String name ()
Nom unique obligatoire pour cette option.
Ce résultat sera mappé à un argument de ligne de commande précédé de deux caractères "-" caractères.
Par exemple, un Option
nommé "help" est spécifié avec "--help" le
de la ligne de commande.
Les noms ne doivent pas contenir le signe deux-points (par exemple, ":").
Renvoie | |
---|---|
String |
requiredForRerun
public boolean requiredForRerun ()
Indique si l'option est nécessaire pour compiler une instruction afin de réexécuter un test.
Le rapporteur de résultats peut essayer de compiler des instructions sur la façon de réexécuter un test et d'inclure le s'affiche dans le résultat. L'instruction doit inclure toutes les options applicables à un test à nouveau. Cet attribut permet d'indiquer si l'option doit être incluse dans une instruction.
Renvoie | |
---|---|
boolean |
Nom court
public char shortName ()
Nom abrégé facultatif pour l'option. Ce mappage sera effectué avec un argument de ligne de commande précédé d'un seul trait d'union "-". Ex. : "-h" où h = shortName. "0" est réservé pour signifier que l'option n'a pas de shortName.
Renvoie | |
---|---|
char |
updateRule (mise à jour une règle)
public OptionUpdateRule updateRule ()
Contrôle le comportement lorsqu'une option est spécifiée plusieurs fois. Notez que cette règle est
complètement ignoré pour les options ERROR(/Collection)
ou ERROR(/Map)
.
Renvoie | |
---|---|
OptionUpdateRule |