ConfigurationFactory

public class ConfigurationFactory
extends Object implements IConfigurationFactory

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

Factory zum Erstellen von IConfiguration.

Zusammenfassung

Verschachtelte Klassen

class ConfigurationFactory.ConfigLoader

Implementierung von IConfigDefLoader, die die eingeschlossenen Konfigurationen aus einer Stammkonfiguration verfolgt und bei rekursiven Einschlüssen eine Ausnahme auslöst. 

class ConfigurationFactory.ExceptionLoader

 

Geschützte Konstrukteure

ConfigurationFactory()

Öffentliche Methoden

void clearMapConfig()

In einigen Fällen müssen wir die Karte löschen.

IConfiguration createConfigurationFromArgs(String[] arrayArgs, unconsumedArgs)

Erstellen Sie die IConfiguration über Befehlszeilenargumente.

IConfiguration 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 dem zweiten Argument null aufruft.

IGlobalConfiguration createGlobalConfigurationFromArgs(String[] arrayArgs, remainingArgs)

IGlobalConfiguration über Befehlszeilenargumente erstellen

IConfiguration 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)

Dumpt den Inhalt der Konfiguration in die angegebene ERROR(/PrintStream)

getConfigList(String subPath, boolean loadFromEnv)

Variante von getConfigList(), mit der angegeben werden kann, ob die Konfiguration auch aus der Umgebung geladen werden soll.

getConfigList()

Liste der Namen aller Konfigurationen zurückgeben, die in den JAR-Dateien im Klassenpfad gefunden wurden.

static IConfigurationFactory getInstance()

Rufen Sie die Singleton-Instanz IConfigurationFactory ab.

void loadAllConfigs(boolean discardExceptions)

Hiermit werden alle Konfigurationen geladen, die im Klassenpfad und in den Verzeichnissen für Testfälle gefunden werden.

void loadAndPrintAllConfigs()

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

void printHelp(PrintStream out)

Druckt die Hilfeausgabe für diese Fabrik aus.

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

Gibt die Hilfeausgabe für IConfiguration aus, die in Befehlszeilenargumenten angegeben ist.

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

Geschützte Methoden

InputStream getBundledConfigStream(String name)
String getConfigPrefix()

Pfadpräfix von Konfigurations-XML-Dateien im Classpath zurückgeben

Sie werden freigegeben, damit sie in Unittests gemockt werden können.

BufferedInputStream getConfigStream(String name)

Lädt einen InputStream für den angegebenen Konfigurationsnamen

ConfigurationDef getConfigurationDef(String name, boolean isGlobal, templateMap)

ConfigurationDef für den angegebenen Namen abrufen

getMapConfig()

Wird für Tests freigegeben.

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

Sortieren Sie die Argumente so, dass die Argumente für „template:map“ an den Anfang gestellt werden.

IRemoteFileResolver.ResolvedFile resolveRemoteFile(URI configURI, URI destDir)

Geschützte Konstrukteure

ConfigurationFactory

protected ConfigurationFactory ()

Öffentliche Methoden

clearMapConfig

public void clearMapConfig ()

In einigen Fällen müssen wir die Karte löschen.

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs, 
                 unconsumedArgs)

Erstellen Sie die IConfiguration über Befehlszeilenargumente.

Das erwartete Format ist „CONFIG [options]“, wobei CONFIG der Name der integrierten Konfiguration oder ein Dateipfad zu einer Konfigurations-XML-Datei ist.

Parameter
arrayArgs String: Befehlszeilenargumente
unconsumedArgs : Eine Liste, die mit den Argumenten gefüllt wird, die von den mit der angegebenen Konfiguration verknüpften Objekten nicht verwendet wurden. Wenn dies null ist, wird von der Implementierung ConfigurationException geworfen, wenn noch nicht verarbeitete Argumente vorhanden sind.
Returns
IConfiguration die geladene IConfiguration. Die Option-Felder des delegierten Objekts wurden mit Werten aus „args“ ausgefüllt.
Ausgabe
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 [options]“, wobei CONFIG der Name der integrierten Konfiguration oder ein Dateipfad zu einer Konfigurations-XML-Datei ist.

Parameter
arrayArgs String: Befehlszeilenargumente
unconsumedArgs : Eine Liste, die mit den Argumenten gefüllt wird, die von den mit der angegebenen Konfiguration verknüpften Objekten nicht verwendet wurden. Wenn dies null ist, wird von der Implementierung ConfigurationException geworfen, wenn noch nicht verarbeitete Argumente vorhanden sind.
keyStoreClient IKeyStoreClient: Ein IKeyStoreClient, mit dem vertrauliche Informationen in den Argumenten abgerufen werden.
Returns
IConfiguration die geladene IConfiguration. Die Option-Felder des delegierten Objekts wurden mit Werten aus „args“ ausgefüllt.
Ausgabe
ConfigurationException

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs)

Eine praktische Methode, die ERROR(/#createConfigurationFromArgs(String[],List)) mit dem zweiten Argument null aufruft. Daher wird ConfigurationException ausgegeben, wenn nicht verwendete Argumente verbleiben.

Parameter
arrayArgs String

Returns
IConfiguration

Ausgabe
ConfigurationException

createGlobalConfigurationFromArgs

public IGlobalConfiguration createGlobalConfigurationFromArgs (String[] arrayArgs, 
                 remainingArgs)

IGlobalConfiguration über Befehlszeilenargumente erstellen

Das erwartete Format ist „CONFIG [options]“, wobei CONFIG der Name der integrierten Konfiguration oder ein Dateipfad zu einer Konfigurations-XML-Datei ist.

Parameter
arrayArgs String: Befehlszeilenargumente
remainingArgs : Eine Liste, die mit den Argumenten gefüllt wird, die nicht als globale Argumente verarbeitet wurden.
Returns
IGlobalConfiguration die geladene IGlobalConfiguration. Die Option-Felder des delegierten Objekts wurden mit Werten aus „args“ ausgefüllt.
Ausgabe
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, mit dem vertrauliche Informationen in den Argumenten abgerufen werden.
allowedObjects : Die zulässigen zu erstellenden Objekte
delegator TradefedDelegator

Returns
IConfiguration Die geladene IConfiguration.
Ausgabe
ConfigurationException

dumpConfig

public void dumpConfig (String configName, 
                PrintStream out)

Dumpt den Inhalt der Konfiguration in die angegebene ERROR(/PrintStream)

Parameter
configName String: Konfigurationsname
out PrintStream: ERROR(/PrintStream), in das die Ausgabe ausgegeben werden soll

getConfigList

public  getConfigList (String subPath, 
                boolean loadFromEnv)

Variante von getConfigList(), mit der angegeben werden kann, ob die Konfiguration auch aus der Umgebung geladen werden soll.

Parameter
subPath String: Name der Unterverzeichnisse, in denen nach der Konfiguration gesucht werden soll. Wenn „null“ festgelegt ist, entspricht das Verhalten dem von getConfigList().
loadFromEnv boolean: „Wahr“, wenn die Konfiguration in der Umgebungsvariablen geladen werden soll.
Returns

getConfigList

public  getConfigList ()

Liste der Namen aller Konfigurationen zurückgeben, die in den JAR-Dateien im Klassenpfad gefunden wurden. Es wird nicht versucht, eine der Konfigurationen zu laden. Daher kann es sein, dass in dieser Liste eine nicht funktionierende Konfiguration enthalten ist.

Returns

getInstance

public static IConfigurationFactory getInstance ()

Rufen Sie die Singleton-Instanz IConfigurationFactory ab.

Returns
IConfigurationFactory

loadAllConfigs

public void loadAllConfigs (boolean discardExceptions)

Hiermit werden alle Konfigurationen geladen, die im Klassenpfad und in den Verzeichnissen für Testfälle gefunden werden.

Parameter
discardExceptions boolean: „wahr“, wenn alle ConfigurationException-Ausnahmen ignoriert werden sollen.
Ausgabe
com.android.tradefed.config.ConfigurationException
ConfigurationException

loadAndPrintAllConfigs

public void loadAndPrintAllConfigs ()

Dienstprogrammmethode, die prüft, ob alle Konfigurationen geladen, analysiert und alle Optionswerte festgelegt werden können. Sie werden nur freigegeben, damit das entsprechende Projekt seine Konfigurationen validieren kann. Sollte nicht in der Console angezeigt werden.

Ausgabe
ConfigurationException wenn mindestens eine Konfiguration nicht geladen werden konnte

printHelp

public void printHelp (PrintStream out)

Druckt die Hilfeausgabe für diese Fabrik aus.

Es werden allgemeine Hilfeinformationen ausgegeben und alle verfügbaren Konfigurationen aufgelistet.

Parameter
out PrintStream: ERROR(/PrintStream), in das die Ausgabe ausgegeben werden soll

printHelpForConfig

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

Gibt die Hilfeausgabe für IConfiguration aus, die in Befehlszeilenargumenten angegeben ist.

Wenn sich „args“ auf eine bekannte Konfiguration bezieht, wird ein IConfiguration-Objekt aus XML erstellt und die Hilfe für diese IConfiguration wird ausgegeben. Alle anderen „args“-Werte werden ignoriert. Das bedeutet, dass im Hilfetext die aktuellen Werte der Options beschrieben werden, die aus XML geladen wurden, und nicht die Optionswerte, die über die Befehlszeilenargumente festgelegt wurden.

Wenn „args“ nicht auf eine bekannte IConfiguration verweist, wird die allgemeine Hilfe für IConfiguration angezeigt.printHelp(PrintStream)

Parameter
args String: Befehlszeilenargumente
importantOnly boolean: Wenn true, wird eine gekürzte Hilfe mit nur den wichtigsten Details ausgegeben.
out PrintStream: ERROR(/PrintStream), in das die Ausgabe ausgegeben werden soll

Geschützte Methoden

getBundledConfigStream

protected InputStream getBundledConfigStream (String name)

Parameter
name String

Returns
InputStream

getConfigPrefix

protected String getConfigPrefix ()

Pfadpräfix von Konfigurations-XML-Dateien im Classpath zurückgeben

Sie werden freigegeben, damit sie in Unittests gemockt werden können.

Returns
String Pfad zu String mit abschließendem Schrägstrich

getConfigStream

protected BufferedInputStream getConfigStream (String name)

Lädt einen InputStream für den angegebenen Konfigurationsnamen

Parameter
name String: der Name der Konfiguration, die geladen werden soll
Returns
BufferedInputStream eine ERROR(/BufferedInputStream) zum Lesen des Konfigurationsinhalts
Ausgabe
ConfigurationException if config could not be found

getConfigurationDef

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

ConfigurationDef für den angegebenen Namen abrufen

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

templateMap

Returns
ConfigurationDef ConfigurationDef
Ausgabe
ConfigurationException wenn beim Laden der Konfiguration ein Fehler aufgetreten ist

getMapConfig

protected  getMapConfig ()

Wird für Tests freigegeben. Gibt eine Kopie der Karte zurück.

Returns

isDirectConfiguration

protected boolean isDirectConfiguration (String configName)

Parameter
configName String

Returns
boolean

reorderArgs

protected String[] reorderArgs (String[] args)

Sortieren Sie die Argumente so, dass die Argumente für „template:map“ an den Anfang gestellt werden.

Parameter
args String

Returns
String[]

resolveRemoteFile

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

Parameter
configURI URI

destDir URI

Returns
IRemoteFileResolver.ResolvedFile

Ausgabe
BuildRetrievalError