IConfigurationFactory

public interface IConfigurationFactory

com.android.tradefed.config.IConfigurationFactory

Factory zum Erstellen von IConfigurations

Zusammenfassung

Öffentliche Methoden

abstract IConfiguration createConfigurationFromArgs(String[] args, unconsumedArgs)

Erstellen Sie die IConfiguration über Befehlszeilenargumente.

abstract IConfiguration createConfigurationFromArgs(String[] args)

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

abstract IConfiguration createConfigurationFromArgs(String[] args, unconsumedArgs, IKeyStoreClient keyStoreClient)

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

abstract IGlobalConfiguration createGlobalConfigurationFromArgs(String[] args, nonGlobalArgs)

IGlobalConfiguration über Befehlszeilenargumente erstellen

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

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

abstract void dumpConfig(String configName, PrintStream out)

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

abstract getConfigList()

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

abstract getConfigList(String subPath, boolean loadFromEnv)

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

abstract void printHelp(PrintStream out)

Druckt die Hilfeausgabe für diese Fabrik aus.

abstract 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.

Öffentliche Methoden

createConfigurationFromArgs

public abstract IConfiguration createConfigurationFromArgs (String[] args, 
                 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
args 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 if configuration could not be loaded

createConfigurationFromArgs

public abstract IConfiguration createConfigurationFromArgs (String[] args)

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

Parameter
args String

Returns
IConfiguration

Ausgabe
ConfigurationException

createConfigurationFromArgs

public abstract IConfiguration createConfigurationFromArgs (String[] args, 
                 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
args 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 if configuration could not be loaded

createGlobalConfigurationFromArgs

public abstract IGlobalConfiguration createGlobalConfigurationFromArgs (String[] args, 
                 nonGlobalArgs)

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
args String: Befehlszeilenargumente
nonGlobalArgs : 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 if configuration could not be loaded

createPartialConfigurationFromArgs

public abstract 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 if configuration could not be loaded

dumpConfig

public abstract 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 abstract  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

getConfigList

public abstract  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

printHelp

public abstract 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 abstract 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