ConfigurationFactory
public
class
ConfigurationFactory
extends Object
implements
IConfigurationFactory
java.lang.Object | |
↳ | com.android.tradefed.config.ConfigurationFactory |
Fábrica para crear IConfiguration
.
Resumen
Clases anidadas | |
---|---|
class |
ConfigurationFactory.ConfigLoader
Implementación de IConfigDefLoader que realiza un seguimiento de las configuraciones incluidas desde una configuración raíz y arroja una excepción en las inclusiones circulares. |
class |
ConfigurationFactory.ExceptionLoader
|
Constructores protegidos | |
---|---|
ConfigurationFactory()
|
Métodos públicos | |
---|---|
void
|
clearMapConfig()
En algunos casos particulares, debemos borrar el mapa. |
IConfiguration
|
createConfigurationFromArgs(String[] arrayArgs,
Crea el |
IConfiguration
|
createConfigurationFromArgs(String[] arrayArgs,
Crea el |
IConfiguration
|
createConfigurationFromArgs(String[] arrayArgs)
Un método de conveniencia que llama a |
IGlobalConfiguration
|
createGlobalConfigurationFromArgs(String[] arrayArgs,
Crea un |
IConfiguration
|
createPartialConfigurationFromArgs(String[] arrayArgs, IKeyStoreClient keyStoreClient,
Crea una configuración que solo contenga un conjunto de objetos seleccionados. |
void
|
dumpConfig(String configName, PrintStream out)
Vuelve a escribir el contenido de la configuración en el |
|
getConfigList(String subPath, boolean loadFromEnv)
Es una variación de |
|
getConfigList()
Muestra la lista de nombres de todas las configuraciones que se encuentran en los archivos JAR de la ruta de clase. |
static
IConfigurationFactory
|
getInstance()
Obtén la instancia singleton |
void
|
loadAllConfigs(boolean discardExceptions)
Carga todas las configuraciones que se encuentran en los directorios de classpath y casos de prueba. |
void
|
loadAndPrintAllConfigs()
Es un método de utilidad que verifica que se puedan cargar, analizar y establecer todos los valores de opción de configuración. |
void
|
printHelp(PrintStream out)
Imprime el resultado de ayuda de esta fábrica. |
void
|
printHelpForConfig(String[] args, boolean importantOnly, PrintStream out)
Imprime el resultado de ayuda para el
Si "args" hace referencia a una configuración conocida, se creará un objeto |
Métodos protegidos | |
---|---|
InputStream
|
getBundledConfigStream(String name)
|
String
|
getConfigPrefix()
Muestra el prefijo de ruta de acceso de los archivos de configuración XML en el classpath Se expone para que las pruebas de unidades puedan simular. |
BufferedInputStream
|
getConfigStream(String name)
Carga un InputStream para un nombre de configuración determinado. |
ConfigurationDef
|
getConfigurationDef(String name, boolean isGlobal,
Recupera el |
|
getMapConfig()
Se expone para pruebas. |
boolean
|
isDirectConfiguration(String configName)
|
String[]
|
reorderArgs(String[] args)
Reordena los argumentos para que los argumentos template:map se muevan al principio. |
IRemoteFileResolver.ResolvedFile
|
resolveRemoteFile(URI configURI, URI destDir)
|
Constructores protegidos
ConfigurationFactory
protected ConfigurationFactory ()
Métodos públicos
clearMapConfig
public void clearMapConfig ()
En algunos casos particulares, debemos borrar el mapa.
createConfigurationFromArgs
public IConfiguration createConfigurationFromArgs (String[] arrayArgs,unconsumedArgs)
Crea el IConfiguration
a partir de argumentos de línea de comandos.
El formato esperado es "CONFIG [options]", en el que CONFIG es el nombre de la configuración integrada o una ruta de acceso a un archivo en formato XML de configuración.
Parámetros | |
---|---|
arrayArgs |
String : Los argumentos de la línea de comandos |
unconsumedArgs |
: Es una lista que se propagará con los argumentos que no consumieron los objetos asociados con la configuración especificada. Si es null , la implementación arrojará ConfigurationException si quedan argumentos sin procesar. |
Muestra | |
---|---|
IConfiguration |
el IConfiguration cargado. Los campos Option del objeto delegado se propagaron con valores en args. |
Arroja | |
---|---|
ConfigurationException |
createConfigurationFromArgs
public IConfiguration createConfigurationFromArgs (String[] arrayArgs,unconsumedArgs, IKeyStoreClient keyStoreClient)
Crea el IConfiguration
a partir de argumentos de línea de comandos con un almacén de claves.
El formato esperado es "CONFIG [options]", en el que CONFIG es el nombre de la configuración integrada o una ruta de acceso a un archivo en formato XML de configuración.
Parámetros | |
---|---|
arrayArgs |
String : Los argumentos de la línea de comandos |
unconsumedArgs |
: Es una lista que se propagará con los argumentos que no consumieron los objetos asociados con la configuración especificada. Si es null , la implementación arrojará ConfigurationException si quedan argumentos sin procesar. |
keyStoreClient |
IKeyStoreClient : Un IKeyStoreClient que se usa para obtener información sensible en los argumentos. |
Muestra | |
---|---|
IConfiguration |
el IConfiguration cargado. Los campos Option del objeto delegado se propagaron con valores en args. |
Arroja | |
---|---|
ConfigurationException |
createConfigurationFromArgs
public IConfiguration createConfigurationFromArgs (String[] arrayArgs)
Un método de conveniencia que llama a ERROR(/#createConfigurationFromArgs(String[],List))
con un segundo argumento null
. Por lo tanto, arrojará ConfigurationException
si queda algún argumento sin consumir.
Parámetros | |
---|---|
arrayArgs |
String |
Muestra | |
---|---|
IConfiguration |
Arroja | |
---|---|
ConfigurationException |
createGlobalConfigurationFromArgs
public IGlobalConfiguration createGlobalConfigurationFromArgs (String[] arrayArgs,remainingArgs)
Crea un IGlobalConfiguration
a partir de argumentos de línea de comandos.
El formato esperado es "CONFIG [options]", en el que CONFIG es el nombre de la configuración integrada o una ruta de acceso a un archivo en formato XML de configuración.
Parámetros | |
---|---|
arrayArgs |
String : Los argumentos de la línea de comandos |
remainingArgs |
: Es una lista que se propagará con los argumentos que no se procesaron como argumentos globales. |
Muestra | |
---|---|
IGlobalConfiguration |
el IGlobalConfiguration cargado. Los campos Option del objeto delegado se propagaron con valores en args. |
Arroja | |
---|---|
ConfigurationException |
createPartialConfigurationFromArgs
public IConfiguration createPartialConfigurationFromArgs (String[] arrayArgs, IKeyStoreClient keyStoreClient,allowedObjects, TradefedDelegator delegator)
Crea una configuración que solo contenga un conjunto de objetos seleccionados.
Parámetros | |
---|---|
arrayArgs |
String : Los argumentos de la línea de comandos |
keyStoreClient |
IKeyStoreClient : Un IKeyStoreClient que se usa para obtener información sensible en los argumentos. |
allowedObjects |
: Es el conjunto de objetos permitidos que se crearán. |
delegator |
TradefedDelegator |
Muestra | |
---|---|
IConfiguration |
Es el IConfiguration cargado. |
Arroja | |
---|---|
ConfigurationException |
dumpConfig
public void dumpConfig (String configName, PrintStream out)
Vuelve a escribir el contenido de la configuración en el ERROR(/PrintStream)
determinado.
Parámetros | |
---|---|
configName |
String : Es el nombre de la configuración. |
out |
PrintStream : Es el ERROR(/PrintStream) al que se volcará el resultado. |
getConfigList
publicgetConfigList (String subPath, boolean loadFromEnv)
Es una variación de getConfigList()
en la que se puede especificar si también queremos cargar la configuración desde el entorno.
Parámetros | |
---|---|
subPath |
String : Es el nombre de los subdirectorios en los que se buscará la configuración. Si es nulo, tendrá el mismo comportamiento que getConfigList() . |
loadFromEnv |
boolean : Es verdadero si debemos cargar la configuración en la variable de entorno. |
Muestra | |
---|---|
|
getConfigList
publicgetConfigList ()
Muestra la lista de nombres de todas las configuraciones que se encuentran en los archivos JAR de la ruta de clase. No intenta cargar ninguna de las configuraciones, por lo que es posible que haya configuraciones que no funcionen en esta lista.
Muestra | |
---|---|
|
getInstance
public static IConfigurationFactory getInstance ()
Obtén la instancia singleton IConfigurationFactory
.
Muestra | |
---|---|
IConfigurationFactory |
loadAllConfigs
public void loadAllConfigs (boolean discardExceptions)
Carga todas las configuraciones que se encuentran en los directorios de classpath y casos de prueba.
Parámetros | |
---|---|
discardExceptions |
boolean : Es verdadero si se debe ignorar cualquier ConfigurationException. |
Arroja | |
---|---|
|
com.android.tradefed.config.ConfigurationException |
ConfigurationException |
loadAndPrintAllConfigs
public void loadAndPrintAllConfigs ()
Es un método de utilidad que verifica que se puedan cargar, analizar y establecer todos los valores de opción de configuración. Solo se expone para que el proyecto correspondiente pueda validar sus parámetros de configuración. No debe exponerse en la consola.
Arroja | |
---|---|
ConfigurationException |
si no se pudo cargar una o más configuraciones |
printHelp
public void printHelp (PrintStream out)
Imprime el resultado de ayuda de esta fábrica.
Imprime información de ayuda genérica y muestra una lista de todas las configuraciones disponibles.
Parámetros | |
---|---|
out |
PrintStream : Es el ERROR(/PrintStream) al que se volcará el resultado. |
printHelpForConfig
public void printHelpForConfig (String[] args, boolean importantOnly, PrintStream out)
Imprime el resultado de ayuda para el IConfiguration
especificado en los argumentos de la línea de comandos.
Si "args" hace referencia a una configuración conocida, se creará un objeto IConfiguration
a partir de XML y se mostrará la ayuda para ese IConfiguration
. Ten en cuenta que se ignorarán todos los demás valores de "args" (es decir, el texto de ayuda describirá los valores actuales de Option
como se cargaron desde XML y no reflejará los valores de la opción establecidos por los argumentos de la línea de comandos).
Si "args" no hace referencia a un IConfiguration
conocido, se mostrará la ayuda genérica de printHelp(PrintStream)
.
Parámetros | |
---|---|
args |
String : Los argumentos de la línea de comandos |
importantOnly |
boolean : Si es true , imprime una ayuda abreviada que solo muestra los detalles importantes. |
out |
PrintStream : Es el ERROR(/PrintStream) al que se volcará el resultado. |
Métodos protegidos
getBundledConfigStream
protected InputStream getBundledConfigStream (String name)
Parámetros | |
---|---|
name |
String |
Muestra | |
---|---|
InputStream |
getConfigPrefix
protected String getConfigPrefix ()
Muestra el prefijo de ruta de acceso de los archivos de configuración XML en el classpath
Se expone para que las pruebas de unidades puedan simular.
Muestra | |
---|---|
String |
Ruta de acceso String con barra final |
getConfigStream
protected BufferedInputStream getConfigStream (String name)
Carga un InputStream para un nombre de configuración determinado.
Parámetros | |
---|---|
name |
String : Es el nombre de la configuración que se cargará. |
Muestra | |
---|---|
BufferedInputStream |
Un ERROR(/BufferedInputStream) para leer el contenido de configuración |
Arroja | |
---|---|
ConfigurationException |
if config could not be found |
getConfigurationDef
protected ConfigurationDef getConfigurationDef (String name, boolean isGlobal,templateMap)
Recupera el ConfigurationDef
para el nombre determinado
Parámetros | |
---|---|
name |
String : Es el nombre de una configuración integrada que se cargará o una ruta de acceso al archivo de configuración que se cargará. |
isGlobal |
boolean |
templateMap |
|
Muestra | |
---|---|
ConfigurationDef |
ConfigurationDef |
Arroja | |
---|---|
ConfigurationException |
si se produjo un error cuando se cargaba la configuración |
getMapConfig
protectedgetMapConfig ()
Se expone para pruebas. Devuelve una copia del mapa.
Muestra | |
---|---|
|
isDirectConfiguration
protected boolean isDirectConfiguration (String configName)
Parámetros | |
---|---|
configName |
String |
Muestra | |
---|---|
boolean |
reorderArgs
protected String[] reorderArgs (String[] args)
Reordena los argumentos para que los argumentos template:map se muevan al principio.
Parámetros | |
---|---|
args |
String |
Muestra | |
---|---|
String[] |
resolveRemoteFile
protected IRemoteFileResolver.ResolvedFile resolveRemoteFile (URI configURI, URI destDir)
Parámetros | |
---|---|
configURI |
URI |
destDir |
URI |
Muestra | |
---|---|
IRemoteFileResolver.ResolvedFile |
Arroja | |
---|---|
BuildRetrievalError |