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 de cette option. |
boolean
|
requiredForRerun()
Indique si l'option est nécessaire pour compiler l'instruction permettant de réexécuter un test. |
char
|
shortName()
Nom abrégé facultatif de 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 (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" s'affiche dans la sortie d'aide abrégée. L'aide d'une option non importante ne s'affiche 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 spécifiques au temps sont analysés. Le champ
long ou Long pour que cet indicateur soit valide. Sinon, une ConfigurationException est générée.
L'unité par défaut est la milliseconde. Le framework de configuration accepte s pour les 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, à condition que chaque unité apparaisse au maximum une fois et que
toutes les unités qui apparaissent soient listées par ordre décroissant d'échelle. Ainsi, par exemple, h ne peut apparaître qu'avant m et qu'après d. Par exemple, "1d2h3m4s5ms" serait une valeur temporelle valide, tout comme "4" ou "4ms". Tous les espaces intégrés
sont ignorés.
| Renvoie | |
|---|---|
boolean |
|
obligatoire
public boolean mandatory ()
Indique si l'option est obligatoire ou facultative.
Le framework de configuration génère une ConfigurationException si l'une des
conditions suivantes est vraie pour un champ obligatoire après l'analyse des options de toutes les sources :
- Le champ est
null. - Le champ est une
Collectionvide.
| Renvoie | |
|---|---|
boolean |
|
nom
public String name ()
Nom unique obligatoire de cette option.
Il correspond à un argument de ligne de commande précédé de deux caractères "-".
Par exemple, un Option nommé "help" est spécifié avec "--help" sur la
ligne de commande.
Les noms ne peuvent pas contenir de deux-points, par exemple ":".
| Renvoie | |
|---|---|
String |
|
requiredForRerun
public boolean requiredForRerun ()
Indique si l'option est nécessaire pour compiler l'instruction permettant 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 message dans le résultat. L'instruction doit inclure toutes les options applicables à une réexécution de test. Cet attribut permet d'indiquer si l'option doit être incluse dans cette instruction.
| Renvoie | |
|---|---|
boolean |
|
shortName
public char shortName ()
Nom abrégé facultatif de l'option. Il correspond à un argument de ligne de commande précédé d'un seul '-'. Par exemple, "-h" où h = shortName. "0" est réservé pour indiquer que l'option n'a pas de shortName.
| Renvoie | |
|---|---|
char |
|
updateRule
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ée pour les options qui sont des Collections ou des Maps.
| Renvoie | |
|---|---|
OptionUpdateRule |
|