ConfigurationFactory

public class ConfigurationFactory
extends Object implements IConfigurationFactory

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

Fabrique permettant de créer des IConfiguration.

Résumé

Classes imbriquées

class ConfigurationFactory.ConfigLoader

Implémentation d'IConfigDefLoader qui suit les configurations incluses à partir d'un configuration racine, et génère une exception lors des inclusions circulaires. 

class ConfigurationFactory.ExceptionLoader

 

Constructeurs protégés

ConfigurationFactory()

Méthodes publiques

void clearMapConfig()

Dans certains cas, nous devons effacer la carte.

IConfiguration createConfigurationFromArgs(String[] arrayArgs, unconsumedArgs)

Créez le IConfiguration à partir d'arguments de ligne de commande.

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

Créez 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 second argument null.

IGlobalConfiguration createGlobalConfigurationFromArgs(String[] arrayArgs, remainingArgs)

Créez un IGlobalConfiguration à partir d'arguments de ligne de commande.

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

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 le ERROR(/PrintStream) donné.

getConfigList(String subPath, boolean loadFromEnv)

Variation de getConfigList() où vous pouvez spécifier si vous souhaitez également charger la configuration à partir de l'environnement.

getConfigList()

Renvoie la liste des noms de toutes les configurations trouvées dans les fichiers JAR du chemin d'accès aux classes.

static IConfigurationFactory getInstance()

Obtenez l'instance du singleton IConfigurationFactory.

void loadAllConfigs(boolean discardExceptions)

Charge toutes les configurations trouvées dans les répertoires de chemin d'accès aux classes et des scénarios 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 les résultats d'aide de cette fabrique.

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

Affiche la sortie d'aide pour l'IConfiguration spécifié dans les arguments de ligne de commande.

Si "args" fait référence à une configuration connue, un objet IConfiguration sera créé à partir du code XML, et l'aide associée à IConfiguration s'affiche.

Méthodes protégées

InputStream getBundledConfigStream(String name)
String getConfigPrefix()

Renvoie le préfixe de chemin d'accès des fichiers XML de configuration sur le chemin d'accès des classes

Exposé pour que les tests unitaires puissent simuler.

BufferedInputStream getConfigStream(String name)

Charge un InputStream pour un nom de configuration donné

ConfigurationDef getConfigurationDef(String name, boolean isGlobal, templateMap)

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

getMapConfig()

Exposée à des fins de test.

boolean isDirectConfiguration(String configName)
String[] reorderArgs(String[] args)

Réorganisez les arguments de sorte que les arguments template:map soient tous placés en premier.

IRemoteFileResolver.ResolvedFile resolveRemoteFile(URI configURI, URI destDir)

Constructeurs protégés

Fabrique de configuration

protected ConfigurationFactory ()

Méthodes publiques

clearMapConfig

public void clearMapConfig ()

Dans certains cas, nous devons effacer la carte.

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs, 
                 unconsumedArgs)

Créez le IConfiguration à partir d'arguments de ligne de commande.

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

Paramètres
arrayArgs String: arguments de la ligne de commande
unconsumedArgs : une liste contenant les arguments qui n'ont pas été consommées par les objets associés à la configuration spécifiée. Si cette est null, l'implémentation génère ConfigurationException s'il reste des arguments non traités.
Renvoie
IConfiguration IConfiguration chargé. Les champs Option de l'objet délégué comportent a été renseigné avec des valeurs en args.
Génère
ConfigurationException

createConfigurationFromArgs

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

Créez 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 la configuration intégrée ou un chemin d'accès à un fichier XML de configuration.

Paramètres
arrayArgs String: arguments de la ligne de commande
unconsumedArgs : une liste contenant les arguments qui n'ont pas été consommées par les objets associés à la configuration spécifiée. Si cette valeur est null, l'implémentation génère une exception ConfigurationException si des arguments non traités restent.
keyStoreClient IKeyStoreClient: IKeyStoreClient utilisé pour obtenir des informations sensibles dans les arguments.
Renvoie
IConfiguration IConfiguration chargé. Les champs Option de l'objet délégué ont été renseignés avec des valeurs dans args.
Génère
ConfigurationException

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs)

Méthode pratique qui appelle ERROR(/#createConfigurationFromArgs(String[],List)) avec un deuxième argument null. Par conséquent, il génère ConfigurationException si des arguments inutilisés restent.

Paramètres
arrayArgs String

Renvoie
IConfiguration

Génère
ConfigurationException

createGlobalConfigurationFromArgs

public IGlobalConfiguration createGlobalConfigurationFromArgs (String[] arrayArgs, 
                 remainingArgs)

Créez un IGlobalConfiguration à partir d'arguments de ligne de commande.

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

Paramètres
arrayArgs String: arguments de la ligne de commande
remainingArgs : une liste contenant les arguments qui n'ont pas été traités en tant qu'arguments globaux
Renvoie
IGlobalConfiguration le IGlobalConfiguration chargé. Les champs Option de l'objet délégué ont été renseignés avec des valeurs dans args.
Génère
ConfigurationException

createPartialConfigurationFromArgs

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

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

Paramètres
arrayArgs String : arguments de ligne de commande
keyStoreClient IKeyStoreClient: IKeyStoreClient utilisé pour obtenir des informations sensibles dans le args.
allowedObjects  : ensemble d'objets autorisés à créer
delegator TradefedDelegator

Renvoie
IConfiguration IConfiguration chargé.
Génère
ConfigurationException

dumpConfig

public void dumpConfig (String configName, 
                PrintStream out)

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

Paramètres
configName String : nom de la configuration
out PrintStream : ERROR(/PrintStream) dans lequel vider la sortie

getConfigList

public  getConfigList (String subPath, 
                boolean loadFromEnv)

Variation de getConfigList() où vous pouvez spécifier si vous souhaitez également charger la configuration à partir de l'environnement.

Paramètres
subPath String: nom des sous-répertoires dans lesquels rechercher la configuration. Si la valeur est nulle, le même comportement que getConfigList().
loadFromEnv boolean : "True" si nous devons charger la configuration dans la variable d'environnement.
Renvoie

getConfigList

public  getConfigList ()

Renvoie la liste des noms de toutes les configurations trouvées dans les fichiers JAR sur le chemin de classe. Ne tente pas de charger les configurations. Il est donc possible que la configuration ne fonctionne pas. de cette liste.

Renvoie

getInstance

public static IConfigurationFactory getInstance ()

Obtenez l'instance du singleton IConfigurationFactory.

Renvoie
IConfigurationFactory

loadAllConfigs

public void loadAllConfigs (boolean discardExceptions)

Charge toutes les configurations trouvées dans les répertoires de chemin d'accès aux classes et des scénarios de test.

Paramètres
discardExceptions boolean : "true" si toute configurationException doit être ignorée.
Génère
com.android.tradefed.config.ConfigurationException
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. Exposé uniquement pour que le projet dépendant puisse valider ses configurations. Ne doit pas être exposé dans la console.

Génère
ConfigurationException si le chargement d'une ou plusieurs configurations échoue ;

printAide

public void printHelp (PrintStream out)

Imprime les résultats d'aide de cette fabrique.

Affiche des informations d'aide générales et répertorie toutes les configurations disponibles.

Paramètres
out PrintStream: le ERROR(/PrintStream) dans lequel vider la sortie

printAideForConfig

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

Affiche la sortie d'aide pour l'IConfiguration spécifié dans les arguments de ligne de commande.

Si "args" fait référence à une configuration connue, un objet IConfiguration est créé à partir du fichier XML, et l'aide de cet IConfiguration est générée. Notez tous les autres "args" seront ignorées (c'est-à-dire que le texte d'aide décrit les valeurs actuelles de Option comme chargé à partir d'un fichier XML, et ne reflète pas les valeurs de l'option définies par les arguments de la ligne de commande.

Si "args" ne fait pas référence à un élément IConfiguration connu, L'aide printHelp(PrintStream) s'affiche.

Paramètres
args String : arguments de ligne de commande
importantOnly boolean: si la valeur est true, imprimez une aide abrégée répertoriant uniquement les détails importants
out PrintStream: le ERROR(/PrintStream) dans lequel vider la sortie

Méthodes protégées

getBundledConfigStream

protected InputStream getBundledConfigStream (String name)

Paramètres
name String

Renvoie
InputStream

getConfigPrefix

protected String getConfigPrefix ()

Renvoie le préfixe de chemin d'accès des fichiers XML de configuration sur le chemin d'accès des classes

Exposé pour que les tests unitaires puissent simuler.

Renvoie
String Chemin String avec barre oblique à la fin

getConfigStream

protected BufferedInputStream getConfigStream (String name)

Charge un objet InputStream pour le nom de configuration donné.

Paramètres
name String: nom de la configuration à charger
Renvoie
BufferedInputStream un ERROR(/BufferedInputStream) pour lire le contenu de la configuration
Génère
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: nom d'une configuration intégrée à charger ou chemin d'accès au fichier de configuration pour charger
isGlobal boolean

templateMap

Renvoie
ConfigurationDef ConfigurationDef
Génère
ConfigurationException Si une erreur s'est produite lors du chargement de la configuration

getMapConfig

protected  getMapConfig ()

Exposé à des fins de test. Renvoie une copie de la carte.

Renvoie

isDirectConfiguration

protected boolean isDirectConfiguration (String configName)

Paramètres
configName String

Renvoie
boolean

réorganiser des objets ;

protected String[] reorderArgs (String[] args)

Réorganisez les arguments de sorte que les arguments "template:map" soient tous placés au premier plan.

Paramètres
args String

Renvoie
String[]

resolveRemoteFile

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

Paramètres
configURI URI

destDir URI

Renvoie
IRemoteFileResolver.ResolvedFile

Génère
BuildRetrievalError