Usine de configuration

public class ConfigurationFactory
extends Object implements IConfigurationFactory

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

Sous-classes directes connues GCSConfigurationFactory , RetryConfigurationFactory , SandboxConfigurationFactory GCSConfigurationFactory Une ConfigurationFactory charge les configurations à partir de Google Cloud Storage. RéessayerConfigurationFactory Usine qui gère les nouvelles tentatives d’une commande. SandboxConfigurationFactory Usine de configuration spéciale pour gérer la création de configurations à des fins de sandboxing.

---

Usine de création 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.
class	ConfigurationFactory.ExceptionLoader

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 la 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 d'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 deuxième argument null .
IGlobalConfiguration	createGlobalConfigurationFromArgs (String[] arrayArgs, remainingArgs) createGlobalConfigurationFromArgs (String[] arrayArgs, remainingArgs) Créez un IGlobalConfiguration à partir des arguments de ligne de commande.
IConfiguration	createPartialConfigurationFromArgs (String[] arrayArgs, IKeyStoreClient keyStoreClient, allowedObjects, TradefedDelegator delegator) createPartialConfigurationFromArgs (String[] arrayArgs, IKeyStoreClient keyStoreClient, allowedObjects, TradefedDelegator delegator) Créez une configuration qui contient uniquement un ensemble d'objets sélectionnés.
void	dumpConfig (String configName, PrintStream out) Vide le contenu de la configuration vers l' ERROR(/PrintStream)
	getConfigList (String subPath, boolean loadFromEnv) Variation de getConfigList() où peut spécifier si l'on souhaite ou non charger également 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 singleton IConfigurationFactory .
void	loadAllConfigs (boolean discardExceptions) Charge toutes les configurations trouvées dans les répertoires classpath et cas de test.
void	loadAndPrintAllConfigs () Méthode utilitaire qui vérifie que toutes les configurations peuvent être chargées, analysées et que toutes les valeurs d'options sont définies.
void	printHelp (PrintStream out) Les impressions aident à la sortie pour cette usine.
void	printHelpForConfig (String[] args, boolean importantOnly, PrintStream out) Imprime la sortie d'aide pour la 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 affichée.

Méthodes protégées
InputStream	getBundledConfigStream (String name)
String	getConfigPrefix () Renvoie le préfixe de chemin des fichiers XML de configuration sur le chemin de classe Exposé afin que les tests unitaires puissent se moquer.
BufferedInputStream	getConfigStream (String name) Charge un InputStream pour le 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.
boolean	isDirectConfiguration (String configName)
String[]	reorderArgs (String[] args) Réorganisez les arguments afin que les arguments template:map soient tous déplacés vers l'avant.
IRemoteFileResolver.ResolvedFile	resolveRemoteFile (URI configURI, URI destDir)

Constructeurs protégés

Usine de configuration

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 la 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 XML de configuration.

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 c'est null , alors l'implémentation lancera ConfigurationException s'il reste des arguments non traités.

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

Jetés
ConfigurationException

createConfigurationFromArgs

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

Créez l' IConfiguration à partir d'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 XML de configuration.

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 c'est null , alors l'implémentation lancera ConfigurationException s'il reste des arguments non traités.
keyStoreClient	IKeyStoreClient : un IKeyStoreClient qui est utilisé pour obtenir des informations sensibles dans les arguments.

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

Jetés
ConfigurationException

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs)

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

Paramètres
arrayArgs	String

Retour
IConfiguration

Jetés
ConfigurationException

createGlobalConfigurationFromArgs

public IGlobalConfiguration createGlobalConfigurationFromArgs (String[] arrayArgs, 
                 remainingArgs)

Créez un 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 XML de configuration.

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 arguments globaux

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

Jetés
ConfigurationException

createPartialConfigurationFromArgs

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

Créez une configuration qui contient uniquement 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 à créer
delegator	TradefedDelegator

Retour
IConfiguration	Le IConfiguration chargé.

Jetés
ConfigurationException

dumpConfig

public void dumpConfig (String configName, 
                PrintStream out)

Vide le contenu de la configuration vers l' ERROR(/PrintStream)

Paramètres
configName	String : le nom de la configuration
out	PrintStream : l' ERROR(/PrintStream) vers laquelle vider la sortie

getConfigList

public  getConfigList (String subPath, 
                boolean loadFromEnv)

Variation de getConfigList() où peut spécifier si l'on souhaite ou non charger également la configuration depuis l'environnement.

Paramètres
subPath	String : nom des sous-répertoires dans lesquels rechercher la configuration. Si null, aura le même comportement que getConfigList() .
loadFromEnv	boolean : True si on doit 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. Ne tente de charger aucune des configurations, il est donc possible d'avoir une configuration qui ne fonctionne pas dans cette liste.

Retour

obtenirInstance

public static IConfigurationFactory getInstance ()

Obtenez l’instance singleton IConfigurationFactory .

Retour
IConfigurationFactory

chargerAllConfigs

public void loadAllConfigs (boolean discardExceptions)

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

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

Jetés
	com.android.tradefed.config.ConfigurationException
ConfigurationException

chargerAndPrintAllConfigs

public void loadAndPrintAllConfigs ()

Méthode utilitaire qui vérifie que toutes les configurations peuvent être chargées, analysées et que toutes les valeurs d'options sont définies. Exposé uniquement afin que les projets dépendants puissent valider leurs configurations. Ne doit pas être exposé dans la console.

Jetés
ConfigurationException	si une ou plusieurs configurations n'ont pas pu être chargées

imprimerAide

public void printHelp (PrintStream out)

Les impressions aident à la sortie 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) vers laquelle vider la sortie

printHelpForConfig

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

Imprime la sortie d'aide pour la 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 affichée. 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 s telles que chargées à partir de XML, et ne reflétera pas les valeurs des options définies par les arguments de la ligne de commande.

Si 'args' ne fait pas référence à un IConfiguration connu, l'aide 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) vers laquelle vider la sortie

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 XML de configuration sur le chemin de classe

Exposé afin que les tests unitaires puissent se moquer.

Retour
String	Chemin String avec / de fin

getConfigStream

protected BufferedInputStream getConfigStream (String name)

Charge un InputStream pour le nom de configuration donné

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

Retour
BufferedInputStream	une ERROR(/BufferedInputStream) pour la lecture du contenu de la configuration

Jetés
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 de fichier vers le fichier de configuration à charger
isGlobal	boolean
templateMap

Retour
ConfigurationDef	ConfigurationDef

Jetés
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

isDirectConfiguration

protected boolean isDirectConfiguration (String configName)

Paramètres
configName	String

Retour
boolean

réorganiserArgs

protected String[] reorderArgs (String[] args)

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

Paramètres
args	String

Retour
String[]

résoudreRemoteFile

protected IRemoteFileResolver.ResolvedFile resolveRemoteFile (URI configURI, 
                URI destDir)

Paramètres
configURI	URI
destDir	URI

Retour
IRemoteFileResolver.ResolvedFile

Jetés
BuildRetrievalError