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 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 sans importance 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, des suffixes spécifiques à l'heure seront analysés. Le champ doit OBLIGATOIREMENT être long ou Long pour que cet indicateur soit valide. Dans le cas contraire, une exception ConfigurationException est générée.

L'unité par défaut est le 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).

Vous pouvez mélanger les unités, à condition que chaque unité n'apparaisse qu'une seule fois et que toutes les unités qui apparaissent soient listées par ordre décroissant d'échelle. Par exemple, h ne peut apparaître qu'avant m et après d. Par exemple, "1d2h3m4s5ms" serait une valeur de temps valide, comme "4" ou "4ms". Tous les espaces intégrés 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 conditions suivantes est vraie pour un champ obligatoire après l'analyse des options à partir de toutes les sources:

Renvoie
boolean

nom

public String name ()

Nom unique obligatoire pour cette option.

Il sera mappé sur un argument de ligne de commande précédé de deux caractères -. Par exemple, une Option nommée "help" serait spécifiée avec "--help" sur la ligne de commande.

Les noms ne doivent 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 pour réexécuter un test et inclure le message dans le résultat. L'instruction doit inclure toutes les options applicables à une nouvelle exécution du test. Cet attribut permet d'indiquer si l'option doit être incluse dans cette 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 tiret ("-"), par exemple "-h", où h = shortName. "0" est réservé pour signifier 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 ERROR(/Collection) ou des ERROR(/Map).

Renvoie
OptionUpdateRule