ConfigurationFactory

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 , die die enthaltenen Konfigurationen von einer Stammkonfiguration verfolgt und eine Ausnahme bei kreisförmigen Includes auslöst.

class ConfigurationFactory.ExceptionLoader

Geschützte Konstruktoren

ConfigurationFactory ()

Öffentliche Methoden

void clearMapConfig ()

In bestimmten Fällen 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 bequeme 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 einen Satz 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() , wo angegeben werden kann, ob wir auch die Konfiguration 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 in Klassenpfad- und Testfallverzeichnissen gefundenen Konfigurationen.

void loadAndPrintAllConfigs ()

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

void printHelp (PrintStream out)

Druckt die Hilfeausgabe für diese Fabrik.

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

Druckt die Hilfeausgabe für die IConfiguration , die in den Befehlszeilenargumenten angegeben ist,

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

Geschützte Methoden

InputStream getBundledConfigStream (String name)
String getConfigPrefix ()

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

Offengelegt, damit Unit-Tests spotten 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 Konstruktoren

ConfigurationFactory

protected ConfigurationFactory ()

Öffentliche Methoden

clearMapConfig

public void clearMapConfig ()

In bestimmten Fällen 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 Objekten verbraucht wurden, die der angegebenen Konfiguration zugeordnet sind. Wenn dies null ist, löst die Implementierung ConfigurationException aus, wenn unverarbeitete Argumente verbleiben.

Kehrt zurück
IConfiguration die geladene IConfiguration . Die Option des Delegatobjekts wurden mit Werten in args ausgefüllt.

Wirft
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 Objekten verbraucht wurden, die der angegebenen Konfiguration zugeordnet sind. Wenn dies null ist, löst die Implementierung ConfigurationException aus, wenn unverarbeitete Argumente verbleiben.

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

Kehrt zurück
IConfiguration die geladene IConfiguration . Die Option des Delegatobjekts wurden mit Werten in args ausgefüllt.

Wirft
ConfigurationException

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs)

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

Parameter
arrayArgs String

Kehrt zurück
IConfiguration

Wirft
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 Delegatobjekts wurden mit Werten in args ausgefüllt.

Wirft
ConfigurationException

createPartialConfigurationFromArgs

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

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

Parameter
arrayArgs String : Die Befehlszeilenargumente

keyStoreClient IKeyStoreClient : Ein IKeyStoreClient , der zum Abrufen vertraulicher Informationen in den Argumenten verwendet wird.

allowedObjects : Die Menge der zulässigen Objekte, die erstellt werden dürfen

delegator TradefedDelegator

Kehrt zurück
IConfiguration Die geladene IConfiguration .

Wirft
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) zum Ausgeben der Ausgabe

getConfigList

public  getConfigList (String subPath, 
                boolean loadFromEnv)

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

Parameter
subPath String : Name der Unterverzeichnisse, in denen nach der 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 nicht, eine 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 in Klassenpfad- und Testfallverzeichnissen gefundenen Konfigurationen.

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

Wirft
com.android.tradefed.config.ConfigurationException
ConfigurationException

loadAndPrintAllConfigs

public void loadAndPrintAllConfigs ()

Hilfsmethode, die überprüft, ob alle Konfigurationen geladen, analysiert und alle Optionswerte gesetzt werden können. Nur verfügbar gemacht, damit abhängige Projekte ihre Konfigurationen validieren können. Sollte nicht in der Konsole angezeigt werden.

Wirft
ConfigurationException wenn eine oder mehrere Konfigurationen nicht geladen werden konnten

DruckenHilfe

public void printHelp (PrintStream out)

Druckt die Hilfeausgabe für diese Fabrik.

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

Parameter
out PrintStream : der ERROR(/PrintStream) zum Ausgeben der Ausgabe

printHelpForConfig

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

Druckt die Hilfeausgabe für die IConfiguration , die in den Befehlszeilenargumenten angegeben ist,

Wenn „args“ auf eine bekannte Konfiguration verweist, wird ein IConfiguration Objekt aus XML erstellt und Hilfe für diese IConfiguration wird ausgegeben. Beachten Sie, dass alle anderen 'args'-Werte ignoriert werden (dh der Hilfetext beschreibt die aktuellen Werte von Option s, wie sie aus XML geladen wurden, und spiegelt nicht die Werte der Option wider, die von den Befehlszeilenargumenten festgelegt wurden.

Wenn 'args' auf keine bekannte IConfiguration verweist, wird die generische printHelp(PrintStream) -Hilfe angezeigt.

Parameter
args String : die Befehlszeilenargumente

importantOnly boolean : wenn true , drucke eine abgekürzte Hilfe, die nur die wichtigen Details auflistet

out PrintStream : der ERROR(/PrintStream) zum Ausgeben der Ausgabe

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 XML-Konfigurationsdateien im Klassenpfad zurück

Offengelegt, damit Unit-Tests spotten können.

Kehrt zurück
String ERROR(/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) zum Lesen von Konfigurationsinhalten

Wirft
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 zu ladenden integrierten Konfiguration oder ein Dateipfad zu einer zu ladenden Konfigurationsdatei

isGlobal boolean

templateMap

Kehrt zurück
ConfigurationDef ConfigurationDef

Wirft
ConfigurationException Wenn beim Laden der Config ein Fehler aufgetreten ist

getMapConfig

protected  getMapConfig ()

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

Kehrt zurück

isDirectConfiguration

protected boolean isDirectConfiguration (String configName)

Parameter
configName String

Kehrt zurück
boolean

neu anordnenArgs

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[]

auflösenRemoteDatei

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

Parameter
configURI URI

destDir URI

Kehrt zurück
IRemoteFileResolver.ResolvedFile

Wirft
BuildRetrievalError