ConfigurazioneFabbrica

public class ConfigurationFactory
extends Object implements IConfigurationFactory

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

Fabbrica per la creazione di IConfiguration.

Riepilogo

Classi nidificate

class ConfigurationFactory.ConfigLoader

Implementazione di IConfigDefLoader che tiene traccia delle configurazioni incluse da uno root config e genera un'eccezione per le inclusioni circolari. 

class ConfigurationFactory.ExceptionLoader

 

Costruttori protetti

ConfigurationFactory()

Metodi pubblici

void clearMapConfig()

In alcuni casi, dobbiamo cancellare i dati della mappa.

IConfiguration createConfigurationFromArgs(String[] arrayArgs, unconsumedArgs)

Crea IConfiguration da argomenti della riga di comando.

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

Crea il IConfiguration da argomenti della riga di comando con un archivio chiavi.

IConfiguration createConfigurationFromArgs(String[] arrayArgs)

Un metodo di utilità che chiama ERROR(/#createConfigurationFromArgs(String[],List)) con un secondo argomento null.

IGlobalConfiguration createGlobalConfigurationFromArgs(String[] arrayArgs, remainingArgs)

Crea un valore IGlobalConfiguration dagli argomenti della riga di comando.

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

Crea una configurazione che contiene solo un insieme di oggetti selezionati.

void dumpConfig(String configName, PrintStream out)

Esegue il dump dei contenuti della configurazione in ERROR(/PrintStream) specificato

getConfigList(String subPath, boolean loadFromEnv)

Variazione di getConfigList() in cui è possibile specificare se vogliamo o meno caricare anche la configurazione dall'ambiente.

getConfigList()

Restituisce l'elenco dei nomi di tutte le configurazioni trovate nei JAR nel percorso di classe.

static IConfigurationFactory getInstance()

Recupera l'istanza singleton IConfigurationFactory.

void loadAllConfigs(boolean discardExceptions)

Carica tutte le configurazioni trovate nelle directory classpath e degli scenari di test.

void loadAndPrintAllConfigs()

Metodo di utilità che verifica che tutte le configurazioni possano essere caricate, analizzate e tutti i valori delle opzioni impostati.

void printHelp(PrintStream out)

Le stampe aiutano a produrre per questa fabbrica.

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

Stampa l'output della guida per il valore IConfiguration specificato negli argomenti della riga di comando.

Se "args" si riferisce a una configurazione nota, verrà creato un oggetto IConfiguration da XML e verrà restituito l'output della guida IConfiguration.

Metodi protetti

InputStream getBundledConfigStream(String name)
String getConfigPrefix()

Restituisce il prefisso del percorso dei file XML di configurazione nel percorso di classe

Esposto in modo che i test delle unità possano essere simulati.

BufferedInputStream getConfigStream(String name)

Carica un InputStream per il nome di configurazione specificato

ConfigurationDef getConfigurationDef(String name, boolean isGlobal, templateMap)

Recupera il ConfigurationDef per il nome specificato

getMapConfig()

Esposizione per i test.

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

Riordina gli argomenti in modo che gli argomenti template:map vengano spostati tutti in primo piano.

IRemoteFileResolver.ResolvedFile resolveRemoteFile(URI configURI, URI destDir)

Costruttori protetti

ConfigurationFactory

protected ConfigurationFactory ()

Metodi pubblici

ClearMapConfig

public void clearMapConfig ()

In alcuni casi, dobbiamo cancellare i dati della mappa.

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs, 
                 unconsumedArgs)

Crea IConfiguration dagli argomenti della riga di comando.

Il formato previsto è "CONFIG [opzioni]", dove CONFIG è il nome della configurazione integrata oppure il percorso di un file XML di configurazione.

Parametri
arrayArgs String: gli argomenti della riga di comando
unconsumedArgs : un elenco che verrà compilato con gli argomenti che non sono stati consumato dagli oggetti associati alla configurazione specificata. Se questo valore è null, l'implementazione restituirà ConfigurationException se rimangono argomenti non elaborati.
Ritorni
IConfiguration il IConfiguration caricato. I campi dell'oggetto delegato Option hanno sono stati compilati con valori negli argomenti.
Lanci
ConfigurationException

createConfigurationFromArgs

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

Crea IConfiguration dagli argomenti della riga di comando con un archivio chiavi.

Il formato previsto è "CONFIG [options]", dove CONFIG è il nome della configurazione integrata o un percorso file a un file XML di configurazione.

Parametri
arrayArgs String: gli argomenti della riga di comando
unconsumedArgs : un elenco che verrà compilato con gli argomenti che non sono stati consumato dagli oggetti associati alla configurazione specificata. Se questo è null, l'implementazione genererà ConfigurationException se rimangono argomenti non elaborati.
keyStoreClient IKeyStoreClient: un IKeyStoreClient utilizzato per ottenere informazioni sensibili in gli argomenti.
Ritorni
IConfiguration il file IConfiguration caricato. I campi dell'oggetto delegato Option sono stati compilati con i valori in args.
Lanci
ConfigurationException

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs)

Un metodo pratico che chiama ERROR(/#createConfigurationFromArgs(String[],List)) con un secondo argomento null. In questo modo, verrà restituito ConfigurationException se rimangono gli argomenti non consumati.

Parametri
arrayArgs String

Ritorni
IConfiguration

Lanci
ConfigurationException

createGlobalConfigurationFromArgs

public IGlobalConfiguration createGlobalConfigurationFromArgs (String[] arrayArgs, 
                 remainingArgs)

Crea un IGlobalConfiguration dagli argomenti della riga di comando.

Il formato previsto è "CONFIG [options]", dove CONFIG è il nome della configurazione integrata o un percorso file a un file XML di configurazione.

Parametri
arrayArgs String: gli argomenti della riga di comando
remainingArgs : un elenco che verrà popolato con gli argomenti che non erano elaborati come argomenti globali
Ritorni
IGlobalConfiguration il file IGlobalConfiguration caricato. I campi Option dell'oggetto delegato sono stati compilati con i valori in args.
Lanci
ConfigurationException

createPartialConfigurationFromArgs

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

Crea una configurazione che contiene solo un insieme di oggetti selezionati.

Parametri
arrayArgs String: gli argomenti della riga di comando
keyStoreClient IKeyStoreClient: un IKeyStoreClient utilizzato per ottenere informazioni sensibili negli argomenti.
allowedObjects : l'insieme di oggetti consentiti da creare
delegator TradefedDelegator

Ritorni
IConfiguration L'elemento IConfiguration caricato.
Lanci
ConfigurationException

dumpConfig

public void dumpConfig (String configName, 
                PrintStream out)

Esegue il dump dei contenuti della configurazione nell'oggetto ERROR(/PrintStream) specificato

Parametri
configName String: il nome della configurazione
out PrintStream: il ERROR(/PrintStream) in cui eseguire il dump dell'output

getConfigList

public  getConfigList (String subPath, 
                boolean loadFromEnv)

Variante di getConfigList() in cui è possibile specificare se vogliamo o meno caricare la configurazione dall'ambiente.

Parametri
subPath String: nome delle sottodirectory in cui cercare la configurazione. Se nullo, avrà lo stesso comportamento di getConfigList().
loadFromEnv boolean: true se dobbiamo caricare la configurazione nella variabile di ambiente.
Ritorni

getConfigList

public  getConfigList ()

Restituisce l'elenco dei nomi di tutte le configurazioni trovate nei JAR nel percorso di classe. Non tenta di caricare nessuna configurazione, quindi è possibile che la configurazione non funzioni in questo elenco.

Ritorni

getInstance

public static IConfigurationFactory getInstance ()

Recupera l'istanza singleton IConfigurationFactory.

Ritorni
IConfigurationFactory

loadAllConfigs

public void loadAllConfigs (boolean discardExceptions)

Carica tutte le configurazioni trovate nelle directory classpath e test case.

Parametri
discardExceptions boolean: true se è necessario ignorare eventuali eccezioni ConfigurationException.
Lanci
com.android.tradefed.config.ConfigurationEccezione
ConfigurationException

loadAndPrintAllConfig

public void loadAndPrintAllConfigs ()

Metodo di utilità che verifica che tutte le configurazioni possano essere caricate, analizzate e tutti i valori delle opzioni impostati. Esposto solo in modo che il progetto in questione possa convalidare le proprie configurazioni. Non devono essere visibili nella console.

Lanci
ConfigurationException se non è stato possibile caricare una o più configurazioni

printHelp

public void printHelp (PrintStream out)

Stampa l'output della guida per questa fabbrica.

Stampa informazioni generiche sulla guida ed elenca tutte le configurazioni disponibili.

Parametri
out PrintStream: il ERROR(/PrintStream) in cui eseguire il dump dell'output

printHelpForConfig

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

Stampa l'output della guida per IConfiguration specificato negli argomenti della riga di comando,

Se "args" fa riferimento a una configurazione nota, verrà creato un oggetto IConfiguration dall'XML e verrà visualizzata la relativa guida. Tieni presente che tutti gli altri valori di "args" verranno ignorati (ad es. il testo del documento di aiuto descriverà i valori correnti di Options come caricati dal file XML e non rifletterà i valori dell'opzione impostati dagli argomenti della riga di comando.

Se "args" non fa riferimento a un IConfiguration noto, il tipo Verrà visualizzata la guida printHelp(PrintStream).

Parametri
args String: gli argomenti della riga di comando
importantOnly boolean: se true, stampa una guida abbreviata elencando solo i dettagli importanti
out PrintStream: il file ERROR(/PrintStream) in cui eseguire il dump dell'output

Metodi protetti

getBundledConfigStream

protected InputStream getBundledConfigStream (String name)

Parametri
name String

Ritorni
InputStream

getConfigPrefix

protected String getConfigPrefix ()

Restituisce il prefisso del percorso dei file XML di configurazione nel percorso di classe

Esposto in modo che i test delle unità possano essere simulati.

Ritorni
String Percorso String con /

getConfigStream

protected BufferedInputStream getConfigStream (String name)

Carica un InputStream per il nome di configurazione specificato

Parametri
name String: il nome della configurazione da caricare
Ritorni
BufferedInputStream un ERROR(/BufferedInputStream) per leggere i contenuti della configurazione
Lanci
ConfigurationException if config could not be found

getConfigurationDef

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

Recupera ConfigurationDef per il nome specificato

Parametri
name String: il nome di una configurazione integrata da caricare o il percorso del file di configurazione per caricare
isGlobal boolean

templateMap

Ritorni
ConfigurationDef ConfigurationDef
Lanci
ConfigurationException Se si è verificato un errore durante il caricamento della configurazione

getMapConfig

protected  getMapConfig ()

Esposizione per i test. Restituire una copia della mappa.

Ritorni

isDirectConfiguration

protected boolean isDirectConfiguration (String configName)

Parametri
configName String

Ritorni
boolean

reorderArgs

protected String[] reorderArgs (String[] args)

Riordina gli argomenti in modo che gli argomenti template:map vengano spostati tutti in primo piano.

Parametri
args String

Ritorni
String[]

risolvereFileRemoto

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

Parametri
configURI URI

destDir URI

Ritorni
IRemoteFileResolver.ResolvedFile

Lanci
BuildRetrievalError