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 ()

L'importance de l'option.

boolean isTimeVal ()

Indique si l'option représente une valeur temporelle.

boolean mandatory ()

Si l'option est obligatoire ou facultative.

String name ()

Le nom unique obligatoire pour cette option.

boolean requiredForRerun ()

Indique si l'option est nécessaire pour compiler l'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 (0x00000030)

Méthodes publiques

description

public String description ()

Description conviviale de l'option.

Retour
String

importance

public Option.Importance importance ()

L'importance de l'option.

Une option considérée comme "importante" sera affichée dans la sortie d'aide abrégée. L'aide pour une option sans importance ne sera affichée que dans le texte d'aide complet.

Retour
Option.Importance

estValHeure

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 seront analysés. Le champ DEVOIR être un long ou Long pour que cet indicateur soit valide. Sinon, une ConfigurationException sera levée.

L'unité par défaut est millis. Le cadre de configuration acceptera s pour les secondes (1 000 millis), 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 assorties, tant que chaque unité apparaît au plus une fois, et tant que toutes les unités qui apparaissent sont répertoriées par ordre décroissant d'échelle. Ainsi, par exemple, h peut n'apparaître qu'avant m , et ne peut apparaître qu'après d . Comme exemple spécifique, "1d2h3m4s5ms" serait une valeur de temps valide, tout comme "4" ou "4ms". Tous les espaces blancs intégrés sont supprimés.

Retour
boolean

obligatoire

public boolean mandatory ()

Si l'option est obligatoire ou facultative.

L'infrastructure de configuration lèvera une ConfigurationException si l'une des conditions suivantes est vraie pour un champ obligatoire après que les options ont été analysées à partir de toutes les sources :

Retour
boolean

nom

public String name ()

Le nom unique obligatoire pour cette option.

Cela correspondra à un argument de ligne de commande précédé de deux caractères '-'. Par exemple, une Option avec le nom 'help' serait spécifiée avec '--help' sur la ligne de commande.

Les noms ne peuvent pas contenir de deux-points, par exemple ':'.

Retour
String

requiredForRerun

public boolean requiredForRerun ()

Indique si l'option est nécessaire pour compiler l'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 message dans le résultat. L'instruction doit inclure toutes les options applicables à une reprise d'essai. Cet attribut est utilisé pour indiquer si l'option doit être incluse dans une telle instruction.

Retour
boolean

nom court

public char shortName ()

Nom abrégé facultatif pour l'option. Cela correspondra à un argument de ligne de commande préfixé par un seul '-'. par exemple "-h" où h = shortName. '0' est réservé pour signifier que l'option n'a pas de shortName.

Retour
char

mettre à jour la 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ée pour les options qui sont ERROR(/Collection) s ou ERROR(/Map) s.

Retour
OptionUpdateRule