ConfigurazioneFabbrica

public class ConfigurationFactory
extends Object implements IConfigurationFactory

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

Factory per la creazione IConfiguration .

Riepilogo

Classi nidificate

class ConfigurationFactory.ConfigLoader

Implementazione di IConfigDefLoader che tiene traccia delle configurazioni incluse da una configurazione root e genera un'eccezione sulle inclusioni circolari.

class ConfigurationFactory.ExceptionLoader

Costruttori protetti

ConfigurationFactory ()

Metodi pubblici

void clearMapConfig ()

In alcuni casi particolari, dobbiamo cancellare la mappa.

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

Crea IConfiguration dagli argomenti della riga di comando.

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

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

IConfiguration createConfigurationFromArgs (String[] arrayArgs)

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

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

Crea un IGlobalConfiguration dagli argomenti della riga di comando.

IConfiguration createPartialConfigurationFromArgs (String[] arrayArgs, IKeyStoreClient keyStoreClient, allowedObjects, TradefedDelegator delegator) 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)

Scarica il contenuto della configurazione nel dato ERROR(/PrintStream)

getConfigList (String subPath, boolean loadFromEnv)

Variante di getConfigList() dove possiamo specificare se vogliamo o meno caricare anche la configurazione dall'ambiente.

getConfigList ()

Restituisce l'elenco dei nomi di tutte le configurazioni trovate nei JAR sul classpath.

static IConfigurationFactory getInstance ()

Ottenere l'istanza IConfigurationFactory singleton.

void loadAllConfigs (boolean discardExceptions)

Carica tutte le configurazioni trovate nelle directory dei percorsi di classe e dei casi di test.

void loadAndPrintAllConfigs ()

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

void printHelp (PrintStream out)

Stampa l'output della guida per questa fabbrica.

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

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

Se 'args' fa riferimento a una configurazione nota, verrà creato un oggetto IConfiguration da XML e verrà emessa la guida per tale IConfiguration .

Metodi protetti

InputStream getBundledConfigStream (String name)
String getConfigPrefix ()

Restituisce il prefisso del percorso dei file xml di configurazione su classpath

Esposto in modo che i test unitari possano deridere.

BufferedInputStream getConfigStream (String name)

Carica un InputStream per un determinato nome di configurazione

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

Recuperare ConfigurationDef per il nome specificato

getMapConfig ()

Esposto per il test.

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

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

IRemoteFileResolver.ResolvedFile resolveRemoteFile (URI configURI, URI destDir)

Costruttori protetti

ConfigurazioneFabbrica

protected ConfigurationFactory ()

Metodi pubblici

clearMapConfig

public void clearMapConfig ()

In alcuni casi particolari, dobbiamo cancellare la 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 incorporata o un percorso file di un file xml di configurazione.

Parametri
arrayArgs String : gli argomenti della riga di comando

unconsumedArgs : una Lista che verrà popolata con gli argomenti che non sono stati consumati dagli Oggetti associati alla configurazione specificata. Se questo è null , l'implementazione genererà ConfigurationException se rimangono argomenti non elaborati.

ritorna
IConfiguration l' IConfiguration caricato. I campi Option dell'oggetto delegato sono stati popolati con i valori in args.

Getta
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 [opzioni]", dove CONFIG è il nome della configurazione incorporata o un percorso file di un file xml di configurazione.

Parametri
arrayArgs String : gli argomenti della riga di comando

unconsumedArgs : una Lista che verrà popolata con gli argomenti che non sono stati consumati 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 riservate negli argomenti.

ritorna
IConfiguration l' IConfiguration caricato. I campi Option dell'oggetto delegato sono stati popolati con i valori in args.

Getta
ConfigurationException

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs)

Un metodo pratico che chiama ERROR(/#createConfigurationFromArgs(String[],List)) con un secondo argomento null . Pertanto, genererà ConfigurationException se rimangono argomenti non consumati.

Parametri
arrayArgs String

ritorna
IConfiguration

Getta
ConfigurationException

createGlobalConfigurationFromArgs

public IGlobalConfiguration createGlobalConfigurationFromArgs (String[] arrayArgs, 
                 remainingArgs)

Crea un IGlobalConfiguration dagli argomenti della riga di comando.

Il formato previsto è "CONFIG [opzioni]", dove CONFIG è il nome della configurazione incorporata o un percorso file di 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 sono stati elaborati come argomenti globali

ritorna
IGlobalConfiguration il IGlobalConfiguration caricato. I campi Option dell'oggetto delegato sono stati popolati con i valori in args.

Getta
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 riservate negli argomenti.

allowedObjects : l'insieme di oggetti consentiti da creare

delegator TradefedDelegator

ritorna
IConfiguration Il IConfiguration caricato.

Getta
ConfigurationException

dumpConfig

public void dumpConfig (String configName, 
                PrintStream out)

Scarica il contenuto della configurazione nel dato ERROR(/PrintStream)

Parametri
configName String : il nome della configurazione

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

getConfigList

public  getConfigList (String subPath, 
                boolean loadFromEnv)

Variante di getConfigList() dove possiamo specificare se vogliamo o meno caricare anche la configurazione dall'ambiente.

Parametri
subPath String : nome delle sottodirectory in cui cercare la configurazione. Se null, avrà lo stesso comportamento di getConfigList() .

loadFromEnv boolean : True se dobbiamo caricare la configurazione nella variabile di ambiente.

ritorna

getConfigList

public  getConfigList ()

Restituisce l'elenco dei nomi di tutte le configurazioni trovate nei JAR sul classpath. Non tenta di caricare nessuna delle configurazioni, quindi è possibile avere configurazioni non funzionanti in questo elenco.

ritorna

getInstance

public static IConfigurationFactory getInstance ()

Ottenere l'istanza IConfigurationFactory singleton.

ritorna
IConfigurationFactory

loadAllConfigs

public void loadAllConfigs (boolean discardExceptions)

Carica tutte le configurazioni trovate nelle directory dei percorsi di classe e dei casi di test.

Parametri
discardExceptions boolean : true se qualsiasi ConfigurationException deve essere ignorata.

Getta
com.android.tradefed.config.ConfigurationException
ConfigurationException

loadAndPrintAllConfigs

public void loadAndPrintAllConfigs ()

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

Getta
ConfigurationException se una o più configurazioni non sono state caricate

printAiuto

public void printHelp (PrintStream out)

Stampa l'output della guida per questa fabbrica.

Stampa informazioni di aiuto generiche ed elenca tutte le configurazioni disponibili.

Parametri
out PrintStream : l' 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 l' IConfiguration specificato negli argomenti della riga di comando,

Se 'args' fa riferimento a una configurazione nota, verrà creato un oggetto IConfiguration da XML e verrà emessa la guida per tale IConfiguration . Nota che tutti gli altri valori 'args' verranno ignorati (ovvero il testo della guida descriverà i valori correnti di Option s come caricati da XML e non rifletterà i valori dell'opzione impostati dalla riga di comando args.

Se 'args' non fa riferimento a un IConfiguration noto, verrà visualizzata la guida generica printHelp(PrintStream) .

Parametri
args String : gli argomenti della riga di comando

importantOnly boolean : se true , stampa una guida abbreviata che elenca solo i dettagli importanti

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

Metodi protetti

getBundledConfigStream

protected InputStream getBundledConfigStream (String name)

Parametri
name String

ritorna
InputStream

getConfigPrefix

protected String getConfigPrefix ()

Restituisce il prefisso del percorso dei file xml di configurazione su classpath

Esposto in modo che i test unitari possano deridere.

ritorna
String ERROR(/String) percorso con finale /

getConfigStream

protected BufferedInputStream getConfigStream (String name)

Carica un InputStream per un determinato nome di configurazione

Parametri
name String : il nome della configurazione da caricare

ritorna
BufferedInputStream un ERROR(/BufferedInputStream) per la lettura del contenuto della configurazione

Getta
ConfigurationException se non è stato possibile trovare la configurazione

getConfigurationDef

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

Recuperare ConfigurationDef per il nome dato

Parametri
name String : il nome di una configurazione integrata da caricare o il percorso di un file di configurazione da caricare

isGlobal boolean

templateMap

ritorna
ConfigurationDef ConfigurationDef

Getta
ConfigurationException se si è verificato un errore durante il caricamento del file config

getMapConfig

protected  getMapConfig ()

Esposto per il test. Restituisci una copia della mappa.

ritorna

isDirectConfiguration

protected boolean isDirectConfiguration (String configName)

Parametri
configName String

ritorna
boolean

reorderArgs

protected String[] reorderArgs (String[] args)

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

Parametri
args String

ritorna
String[]

resolveRemoteFile

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

Parametri
configURI URI

destDir URI

ritorna
IRemoteFileResolver.ResolvedFile

Getta
BuildRetrievalError