Konfigurationsfabrik

public class ConfigurationFactory
extends Object implements IConfigurationFactory

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

Factory zum Erstellen IConfiguration .

Zusammenfassung

Verschachtelte Klassen

class ConfigurationFactory.ConfigLoader

Implementierung von IConfigDefLoader, der die enthaltenen Konfigurationen aus einer Root-Konfiguration verfolgt und bei zirkulären Includes eine Ausnahme auslöst.

class ConfigurationFactory.ExceptionLoader

Geschützte Konstrukteure

ConfigurationFactory ()

Öffentliche Methoden

void clearMapConfig ()

In einem bestimmten Fall müssen wir die Karte löschen.

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

Erstellen Sie die IConfiguration aus Befehlszeilenargumenten.

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

Erstellen Sie die IConfiguration aus Befehlszeilenargumenten mit einem Schlüsselspeicher.

IConfiguration createConfigurationFromArgs (String[] arrayArgs)

Eine praktische Methode, die ERROR(/#createConfigurationFromArgs(String[],List)) mit einem zweiten null aufruft.

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

Erstellen Sie eine IGlobalConfiguration aus Befehlszeilenargumenten.

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

Erstellen Sie eine Konfiguration, die nur eine Reihe ausgewählter Objekte enthält.

void dumpConfig (String configName, PrintStream out)

Gibt den Inhalt der Konfiguration an den angegebenen ERROR(/PrintStream) aus.

getConfigList (String subPath, boolean loadFromEnv)

Variation von getConfigList() , bei der angegeben werden kann, ob wir die Konfiguration auch aus der Umgebung laden möchten oder nicht.

getConfigList ()

Gibt die Liste der Namen aller Konfigurationen zurück, die in den JARs im Klassenpfad gefunden wurden.

static IConfigurationFactory getInstance ()

Rufen Sie die Singleton IConfigurationFactory Instanz ab.

void loadAllConfigs (boolean discardExceptions)

Lädt alle Konfigurationen, die in Klassenpfad- und Testfallverzeichnissen gefunden werden.

void loadAndPrintAllConfigs ()

Dienstprogrammmethode, die überprüft, ob alle Konfigurationen geladen, analysiert und alle Optionswerte festgelegt werden können.

void printHelp (PrintStream out)

Druckt die Hilfeausgabe für diese Factory.

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

Gibt eine Hilfeausgabe für die in Befehlszeilenargumenten angegebene IConfiguration aus.

Wenn sich „args“ auf eine bekannte Konfiguration bezieht, wird aus XML ein IConfiguration Objekt erstellt und Hilfe für diese IConfiguration ausgegeben.

Geschützte Methoden

InputStream getBundledConfigStream (String name)
String getConfigPrefix ()

Gibt das Pfadpräfix der Konfigurations-XML-Dateien im Klassenpfad zurück

Offengelegt, damit Unit-Tests verspotten können.

BufferedInputStream getConfigStream (String name)

Lädt einen InputStream für den angegebenen Konfigurationsnamen

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

Rufen Sie die ConfigurationDef für den angegebenen Namen ab

getMapConfig ()

Zum Testen ausgesetzt.

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

Ordnen Sie die Argumente neu an, sodass alle template:map-Argumente nach vorne verschoben werden.

IRemoteFileResolver.ResolvedFile resolveRemoteFile (URI configURI, URI destDir)

Geschützte Konstrukteure

Konfigurationsfabrik

protected ConfigurationFactory ()

Öffentliche Methoden

clearMapConfig

public void clearMapConfig ()

In einem bestimmten Fall müssen wir die Karte löschen.

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs, 
                 unconsumedArgs)

Erstellen Sie die IConfiguration aus Befehlszeilenargumenten.

Das erwartete Format ist „CONFIG [Optionen]“, wobei CONFIG der integrierte Konfigurationsname oder ein Dateipfad zu einer Konfigurations-XML-Datei ist.

Parameter
arrayArgs String : die Befehlszeilenargumente

unconsumedArgs : eine Liste, die mit den Argumenten gefüllt wird, die nicht von den mit der angegebenen Konfiguration verknüpften Objekten verbraucht wurden. Wenn dies null ist, löst die Implementierung ConfigurationException aus, wenn noch unverarbeitete Argumente übrig sind.

Kehrt zurück
IConfiguration die geladene IConfiguration . Die Option des Delegate-Objekts wurden mit Werten in args gefüllt.

Würfe
ConfigurationException

createConfigurationFromArgs

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

Erstellen Sie die IConfiguration aus Befehlszeilenargumenten mit einem Schlüsselspeicher.

Das erwartete Format ist „CONFIG [Optionen]“, wobei CONFIG der integrierte Konfigurationsname oder ein Dateipfad zu einer Konfigurations-XML-Datei ist.

Parameter
arrayArgs String : die Befehlszeilenargumente

unconsumedArgs : eine Liste, die mit den Argumenten gefüllt wird, die nicht von den mit der angegebenen Konfiguration verknüpften Objekten verbraucht wurden. Wenn dies null ist, löst die Implementierung ConfigurationException aus, wenn noch unverarbeitete Argumente übrig sind.

keyStoreClient IKeyStoreClient : ein IKeyStoreClient , der verwendet wird, um vertrauliche Informationen in den Argumenten abzurufen.

Kehrt zurück
IConfiguration die geladene IConfiguration . Die Option des Delegate-Objekts wurden mit Werten in args gefüllt.

Würfe
ConfigurationException

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs)

Eine praktische Methode, die ERROR(/#createConfigurationFromArgs(String[],List)) mit einem zweiten null aufruft. Daher wird ConfigurationException ausgelöst, wenn noch nicht verbrauchte Argumente übrig bleiben.

Parameter
arrayArgs String

Kehrt zurück
IConfiguration

Würfe
ConfigurationException

createGlobalConfigurationFromArgs

public IGlobalConfiguration createGlobalConfigurationFromArgs (String[] arrayArgs, 
                 remainingArgs)

Erstellen Sie eine IGlobalConfiguration aus Befehlszeilenargumenten.

Das erwartete Format ist „CONFIG [Optionen]“, wobei CONFIG der integrierte Konfigurationsname oder ein Dateipfad zu einer Konfigurations-XML-Datei ist.

Parameter
arrayArgs String : die Befehlszeilenargumente

remainingArgs : eine Liste, die mit den Argumenten gefüllt wird, die nicht als globale Argumente verarbeitet wurden

Kehrt zurück
IGlobalConfiguration die geladene IGlobalConfiguration . Die Option des Delegate-Objekts wurden mit Werten in args gefüllt.

Würfe
ConfigurationException

createPartialConfigurationFromArgs

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

Erstellen Sie eine Konfiguration, die nur eine Reihe ausgewählter Objekte enthält.

Parameter
arrayArgs String : Die Befehlszeilenargumente

keyStoreClient IKeyStoreClient : Ein IKeyStoreClient , der verwendet wird, um vertrauliche Informationen in den Argumenten abzurufen.

allowedObjects : Der Satz erlaubter Objekte, die erstellt werden dürfen

delegator TradefedDelegator

Kehrt zurück
IConfiguration Die geladene IConfiguration .

Würfe
ConfigurationException

dumpConfig

public void dumpConfig (String configName, 
                PrintStream out)

Gibt den Inhalt der Konfiguration an den angegebenen ERROR(/PrintStream) aus.

Parameter
configName String : der Konfigurationsname

out PrintStream : der ERROR(/PrintStream) an den die Ausgabe ausgegeben werden soll

getConfigList

public  getConfigList (String subPath, 
                boolean loadFromEnv)

Variation von getConfigList() , bei der angegeben werden kann, ob wir die Konfiguration auch aus der Umgebung laden möchten oder nicht.

Parameter
subPath String : Name der Unterverzeichnisse, in denen nach Konfiguration gesucht werden soll. Wenn null, hat es das gleiche Verhalten wie getConfigList() .

loadFromEnv boolean : True, wenn wir die Konfiguration in die Umgebungsvariable laden sollen.

Kehrt zurück

getConfigList

public  getConfigList ()

Gibt die Liste der Namen aller Konfigurationen zurück, die in den JARs im Klassenpfad gefunden wurden. Versucht keine der Konfigurationen zu laden, daher ist es möglich, dass diese Liste nicht funktionierende Konfigurationen enthält.

Kehrt zurück

bekomme Instanz

public static IConfigurationFactory getInstance ()

Rufen Sie die Singleton IConfigurationFactory Instanz ab.

Kehrt zurück
IConfigurationFactory

LoadAllConfigs

public void loadAllConfigs (boolean discardExceptions)

Lädt alle Konfigurationen, die in Klassenpfad- und Testfallverzeichnissen gefunden werden.

Parameter
discardExceptions boolean : true, wenn eine ConfigurationException ignoriert werden soll.

Würfe
com.android.tradefed.config.ConfigurationException
ConfigurationException

LoadAndPrintAllConfigs

public void loadAndPrintAllConfigs ()

Dienstprogrammmethode, die überprüft, ob alle Konfigurationen geladen, analysiert und alle Optionswerte festgelegt werden können. Nur verfügbar gemacht, damit das jeweilige Projekt seine Konfigurationen validieren kann. Sollte nicht in der Konsole sichtbar sein.

Würfe
ConfigurationException wenn eine oder mehrere Konfigurationen nicht geladen werden konnten

printHelp

public void printHelp (PrintStream out)

Druckt die Hilfeausgabe für diese Factory.

Druckt allgemeine Hilfeinformationen und listet alle verfügbaren Konfigurationen auf.

Parameter
out PrintStream : der ERROR(/PrintStream) an den die Ausgabe ausgegeben werden soll

printHelpForConfig

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

Gibt eine Hilfeausgabe für die in Befehlszeilenargumenten angegebene IConfiguration aus.

Wenn sich „args“ auf eine bekannte Konfiguration bezieht, wird aus XML ein IConfiguration Objekt erstellt und Hilfe für diese IConfiguration ausgegeben. Beachten Sie, dass alle anderen „args“-Werte ignoriert werden (d. h. der Hilfetext beschreibt die aktuellen Werte von Option s, wie sie aus XML geladen wurden, und gibt nicht die durch die Befehlszeilenargumente festgelegten Optionswerte wieder.

Wenn „args“ nicht auf eine bekannte IConfiguration verweist, wird die generische printHelp(PrintStream) -Hilfe angezeigt.

Parameter
args String : die Befehlszeilenargumente

importantOnly boolean : Wenn true , wird eine Kurzhilfe gedruckt, die nur die wichtigen Details auflistet

out PrintStream : der ERROR(/PrintStream) an den die Ausgabe ausgegeben werden soll

Geschützte Methoden

getBundledConfigStream

protected InputStream getBundledConfigStream (String name)

Parameter
name String

Kehrt zurück
InputStream

getConfigPrefix

protected String getConfigPrefix ()

Gibt das Pfadpräfix der Konfigurations-XML-Dateien im Klassenpfad zurück

Offengelegt, damit Unit-Tests verspotten können.

Kehrt zurück
String String Pfad mit abschließendem /

getConfigStream

protected BufferedInputStream getConfigStream (String name)

Lädt einen InputStream für den angegebenen Konfigurationsnamen

Parameter
name String : der zu ladende Konfigurationsname

Kehrt zurück
BufferedInputStream ein ERROR(/BufferedInputStream) beim Lesen von Konfigurationsinhalten

Würfe
ConfigurationException wenn die Konfiguration nicht gefunden werden konnte

getConfigurationDef

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

Rufen Sie die ConfigurationDef für den angegebenen Namen ab

Parameter
name String : Der Name einer integrierten Konfiguration, die geladen werden soll, oder ein Dateipfad zur zu ladenden Konfigurationsdatei

isGlobal boolean

templateMap

Kehrt zurück
ConfigurationDef ConfigurationDef

Würfe
ConfigurationException wenn beim Laden der Konfiguration ein Fehler aufgetreten ist

getMapConfig

protected  getMapConfig ()

Zum Testen ausgesetzt. Geben Sie eine Kopie der Karte zurück.

Kehrt zurück

isDirectConfiguration

protected boolean isDirectConfiguration (String configName)

Parameter
configName String

Kehrt zurück
boolean

reorderArgs

protected String[] reorderArgs (String[] args)

Ordnen Sie die Argumente neu an, sodass alle template:map-Argumente nach vorne verschoben werden.

Parameter
args String

Kehrt zurück
String[]

„resolveRemoteFile“.

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

Parameter
configURI URI

destDir URI

Kehrt zurück
IRemoteFileResolver.ResolvedFile

Würfe
BuildRetrievalError