Google is committed to advancing racial equity for Black communities. See how.
Cette page a été traduite par l'API Cloud Translation.
Switch to English

ConfigurationFactory

public class ConfigurationFactory
extends Object implements IConfigurationFactory

java.lang.Object
com.android.tradefed.config.ConfigurationFactory


Usine de création d' IConfiguration .

Résumé

Classes imbriquées

class ConfigurationFactory.ConfigLoader

Implémentation de IConfigDefLoader qui suit les configurations incluses à partir d'une configuration racine et lève une exception sur les inclusions circulaires.

Constructeurs protégés

ConfigurationFactory ()

Méthodes publiques

void clearMapConfig ()

Dans certains cas particuliers, nous devons effacer la carte.

IConfiguration createConfigurationFromArgs (String[] arrayArgs, unconsumedArgs) createConfigurationFromArgs (String[] arrayArgs, unconsumedArgs)

Créez l' IConfiguration partir des arguments de ligne de commande.

IConfiguration createConfigurationFromArgs (String[] arrayArgs, unconsumedArgs, IKeyStoreClient keyStoreClient) createConfigurationFromArgs (String[] arrayArgs, unconsumedArgs, IKeyStoreClient keyStoreClient)

Créez l' IConfiguration partir des arguments de ligne de commande avec un magasin de clés.

IConfiguration createConfigurationFromArgs (String[] arrayArgs)

Une méthode pratique qui appelle ERROR(/#createConfigurationFromArgs(String[],List)) avec un second argument null .

IGlobalConfiguration createGlobalConfigurationFromArgs (String[] arrayArgs, remainingArgs) createGlobalConfigurationFromArgs (String[] arrayArgs, remainingArgs)

Créez une IGlobalConfiguration partir des arguments de ligne de commande.

IConfiguration createPartialConfigurationFromArgs (String[] arrayArgs, IKeyStoreClient keyStoreClient, allowedObjects) createPartialConfigurationFromArgs (String[] arrayArgs, IKeyStoreClient keyStoreClient, allowedObjects)

Créez une configuration qui ne contient qu'un ensemble d'objets sélectionnés.

void dumpConfig (String configName, PrintStream out)

Vide le contenu de la configuration dans l' ERROR(/PrintStream) donnée ERROR(/PrintStream)

getConfigList (String subPath, boolean loadFromEnv)

Variante de getConfigList() où peut spécifier si nous voulons également charger la configuration depuis l'environnement.

getConfigList ()

Renvoie la liste des noms de toutes les configurations trouvées dans les JAR sur le chemin de classe.

static IConfigurationFactory getInstance ()

Obtenez l'instance de singleton IConfigurationFactory .

void loadAllConfigs (boolean discardExceptions)

Charge toutes les configurations trouvées dans les répertoires de chemin de classe et de cas de test.

void loadAndPrintAllConfigs ()

Méthode utilitaire qui vérifie que toutes les configurations peuvent être chargées, analysées et toutes les valeurs d'option définies.

void printHelp (PrintStream out)

Imprime la sortie d'aide pour cette usine.

void printHelpForConfig (String[] args, boolean importantOnly, PrintStream out)

Imprime la sortie d'aide pour l' IConfiguration spécifiée dans les arguments de ligne de commande,

Si «args» fait référence à une configuration connue, un objet IConfiguration sera créé à partir de XML et une aide pour cette IConfiguration sera IConfiguration .

Méthodes protégées

InputStream getBundledConfigStream (String name)
String getConfigPrefix ()

Renvoie le préfixe de chemin des fichiers de configuration xml sur le chemin de classe

Exposé pour que les tests unitaires puissent se moquer.

BufferedInputStream getConfigStream (String name)

Charge un InputStream pour un nom de configuration donné

ConfigurationDef getConfigurationDef (String name, boolean isGlobal, templateMap) getConfigurationDef (String name, boolean isGlobal, templateMap)

Récupérer le ConfigurationDef pour le nom donné

getMapConfig ()

Exposé pour les tests.

String[] reorderArgs (String[] args)

Réorganisez les arguments pour que les arguments template: map soient tous déplacés vers l'avant.

Constructeurs protégés

ConfigurationFactory

protected ConfigurationFactory ()

Méthodes publiques

clearMapConfig

public void clearMapConfig ()

Dans certains cas particuliers, nous devons effacer la carte.

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs, 
                 unconsumedArgs)

Créez l' IConfiguration partir des arguments de ligne de commande.

Le format attendu est "CONFIG [options]", où CONFIG est le nom de configuration intégré ou un chemin d'accès à un fichier de configuration xml.

Paramètres
arrayArgs String : les arguments de la ligne de commande

unconsumedArgs : une liste qui sera remplie avec les arguments qui n'ont pas été consommés par les objets associés à la configuration spécifiée. Si ce null est null , l'implémentation lèvera ConfigurationException s'il reste des arguments non traités.

Retour
IConfiguration l' IConfiguration chargée. Les champs Option objet délégué ont été remplis avec des valeurs dans args.

Jette
ConfigurationException

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs, 
                 unconsumedArgs, 
                IKeyStoreClient keyStoreClient)

Créez l' IConfiguration partir des arguments de ligne de commande avec un magasin de clés.

Le format attendu est "CONFIG [options]", où CONFIG est le nom de configuration intégré ou un chemin d'accès à un fichier de configuration xml.

Paramètres
arrayArgs String : les arguments de la ligne de commande

unconsumedArgs : une liste qui sera remplie avec les arguments qui n'ont pas été consommés par les objets associés à la configuration spécifiée. Si ce null est null , l'implémentation lèvera ConfigurationException s'il reste des arguments non traités.

keyStoreClient IKeyStoreClient : un IKeyStoreClient qui est utilisé pour obtenir des informations sensibles dans les args.

Retour
IConfiguration l' IConfiguration chargée. Les champs Option objet délégué ont été remplis avec des valeurs dans args.

Jette
ConfigurationException

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs)

Une méthode pratique qui appelle ERROR(/#createConfigurationFromArgs(String[],List)) avec un second argument null . Ainsi, il lèvera ConfigurationException s'il reste des arguments non utilisés.

Paramètres
arrayArgs String

Retour
IConfiguration

Jette
ConfigurationException

createGlobalConfigurationFromArgs

public IGlobalConfiguration createGlobalConfigurationFromArgs (String[] arrayArgs, 
                 remainingArgs)

Créez une IGlobalConfiguration partir des arguments de ligne de commande.

Le format attendu est "CONFIG [options]", où CONFIG est le nom de configuration intégré ou un chemin d'accès à un fichier de configuration xml.

Paramètres
arrayArgs String : les arguments de la ligne de commande

remainingArgs : une liste qui sera remplie avec les arguments qui n'ont pas été traités comme des arguments globaux

Retour
IGlobalConfiguration l' IGlobalConfiguration chargé. Les champs Option objet délégué ont été remplis avec des valeurs dans args.

Jette
ConfigurationException

createPartialConfigurationFromArgs

public IConfiguration createPartialConfigurationFromArgs (String[] arrayArgs, 
                IKeyStoreClient keyStoreClient, 
                 allowedObjects)

Créez une configuration qui ne contient qu'un ensemble d'objets sélectionnés.

Paramètres
arrayArgs String : les arguments de la ligne de commande

keyStoreClient IKeyStoreClient : Un IKeyStoreClient qui est utilisé pour obtenir des informations sensibles dans les arguments.

allowedObjects : L'ensemble des objets autorisés à être créés

Retour
IConfiguration IConfiguration chargée.

Jette
ConfigurationException

dumpConfig

public void dumpConfig (String configName, 
                PrintStream out)

Vide le contenu de la configuration dans l' ERROR(/PrintStream) donnée ERROR(/PrintStream)

Paramètres
configName String : le nom de la configuration

out PrintStream : l' ERROR(/PrintStream) pour vider la sortie vers

getConfigList

public  getConfigList (String subPath, 
                boolean loadFromEnv)

Variante de getConfigList() où peut spécifier si nous voulons également charger la configuration depuis l'environnement.

Paramètres
subPath String : nom des sous-répertoires à rechercher pour la configuration. Si null, aura le même comportement que getConfigList() .

loadFromEnv boolean : True si nous devons charger la configuration dans la variable d'environnement.

Retour

getConfigList

public  getConfigList ()

Renvoie la liste des noms de toutes les configurations trouvées dans les JAR sur le chemin de classe. N'essaye pas de charger l'une des configurations, il est donc possible d'avoir une configuration non fonctionnelle dans cette liste.

Retour

getInstance

public static IConfigurationFactory getInstance ()

Obtenez l'instance de singleton IConfigurationFactory .

Retour
IConfigurationFactory

loadAllConfigs

public void loadAllConfigs (boolean discardExceptions)

Charge toutes les configurations trouvées dans les répertoires de chemin de classe et de cas de test.

Paramètres
discardExceptions boolean : true si une exception ConfigurationException doit être ignorée.

Jette
ConfigurationException

loadAndPrintAllConfigs

public void loadAndPrintAllConfigs ()

Méthode utilitaire qui vérifie que toutes les configurations peuvent être chargées, analysées et toutes les valeurs d'option définies. Uniquement exposé pour que le projet dépendant puisse valider leurs configurations. Ne doit pas être exposé dans la console.

Jette
ConfigurationException si une ou plusieurs configurations ne parviennent pas à se charger

imprimerAide

public void printHelp (PrintStream out)

Imprime la sortie d'aide pour cette usine.

Imprime une information d'aide générique et répertorie toutes les configurations disponibles.

Paramètres
out PrintStream : l' ERROR(/PrintStream) pour vider la sortie vers

printHelpForConfig

public void printHelpForConfig (String[] args, 
                boolean importantOnly, 
                PrintStream out)

Imprime la sortie d'aide pour l' IConfiguration spécifiée dans les arguments de ligne de commande,

Si «args» fait référence à une configuration connue, un objet IConfiguration sera créé à partir de XML et une aide pour cette IConfiguration sera IConfiguration . Notez que toutes les autres valeurs «args» seront ignorées (c'est-à-dire que le texte d'aide décrira les valeurs actuelles des Option comme chargées depuis XML, et ne reflétera pas les valeurs d'option définies par la ligne de commande args.

Si 'args' ne fait pas référence à une IConfiguration connue, l' printHelp(PrintStream) générique printHelp(PrintStream) sera affichée.

Paramètres
args String : les arguments de la ligne de commande

importantOnly boolean : si true , affiche une aide abrégée répertoriant uniquement les détails importants

out PrintStream : l' ERROR(/PrintStream) pour vider la sortie vers

Méthodes protégées

getBundledConfigStream

protected InputStream getBundledConfigStream (String name)

Paramètres
name String

Retour
InputStream

getConfigPrefix

protected String getConfigPrefix ()

Renvoie le préfixe de chemin des fichiers de configuration xml sur le chemin de classe

Exposé pour que les tests unitaires puissent se moquer.

Retour
String Chemin de String avec fin /

getConfigStream

protected BufferedInputStream getConfigStream (String name)

Charge un InputStream pour un nom de configuration donné

Paramètres
name String : le nom de la configuration à charger

Retour
BufferedInputStream une ERROR(/BufferedInputStream) pour lire le contenu de la configuration

Jette
ConfigurationException si la configuration est introuvable

getConfigurationDef

protected ConfigurationDef getConfigurationDef (String name, 
                boolean isGlobal, 
                 templateMap)

Récupérer le ConfigurationDef pour le nom donné

Paramètres
name String : le nom d'une configuration intégrée à charger ou un chemin d'accès au fichier de configuration à charger

isGlobal boolean

templateMap

Retour
ConfigurationDef ConfigurationDef

Jette
ConfigurationException si une erreur s'est produite lors du chargement de la configuration

getMapConfig

protected  getMapConfig ()

Exposé pour les tests. Renvoyez une copie de la carte.

Retour

réorganiser

protected String[] reorderArgs (String[] args)

Réorganisez les arguments pour que les arguments template: map soient tous déplacés vers l'avant.

Paramètres
args String

Retour
String[]