ConfiguraciónFactory
public
class
ConfigurationFactory
extends Object
implements
IConfigurationFactory
Objeto java.lang. | |
↳ | 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 los parámetros de configuración incluidos desde uno raíz y arroja una excepción en inclusiones circulares. |
class |
ConfigurationFactory.ExceptionLoader
|
Constructores protegidos | |
---|---|
ConfigurationFactory()
|
Métodos públicos | |
---|---|
void
|
clearMapConfig()
En algún caso particular, necesitamos 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)
Vuelca el contenido de la configuración en el |
|
getConfigList(String subPath, boolean loadFromEnv)
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 ruta de clase y de casos de prueba. |
void
|
loadAndPrintAllConfigs()
Es un método de utilidad que comprueba que todas las configuraciones se puedan cargar, analizar y todos los valores de opción establecidos. |
void
|
printHelp(PrintStream out)
Imprime la salida de ayuda de la 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()
Devuelve el prefijo de ruta de acceso de los archivos de configuración en formato XML en la ruta de clase Está expuesto 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 los |
|
getMapConfig()
Expuesto para realizar pruebas. |
boolean
|
isDirectConfiguration(String configName)
|
String[]
|
reorderArgs(String[] args)
Reordena los argumentos para que los argumentos template:map se muevan al frente. |
IRemoteFileResolver.ResolvedFile
|
resolveRemoteFile(URI configURI, URI destDir)
|
Constructores protegidos
ConfiguraciónFactory
protected ConfigurationFactory ()
Métodos públicos
clearMapConfig
public void clearMapConfig ()
En algún caso particular, necesitamos borrar el mapa.
createConfigurationFromArgs
public IConfiguration createConfigurationFromArgs (String[] arrayArgs,unconsumedArgs)
Crea el IConfiguration
a partir de los argumentos de la línea de comandos.
El formato esperado es “CONFIG [opciones]”, donde CONFIG es el nombre de la configuración integrada o una ruta de acceso a un archivo de configuración en formato XML.
Parámetros | |
---|---|
arrayArgs |
String : Son los argumentos de la línea de comandos. |
unconsumedArgs |
: Una lista que se propagará con los argumentos que no se
que consumen los objetos asociados con la configuración especificada. Si esta
es null , la implementación arrojará
Es ConfigurationException si quedan argumentos sin procesar. |
Muestra | |
---|---|
IConfiguration |
el IConfiguration cargado. Los campos Option del objeto delegado tienen
con valores en args. |
Arroja | |
---|---|
ConfigurationException |
createConfigurationFromArgs
public IConfiguration createConfigurationFromArgs (String[] arrayArgs,unconsumedArgs, IKeyStoreClient keyStoreClient)
Crea el IConfiguration
a partir de los argumentos de la línea de comandos con un almacén de claves.
El formato esperado es “CONFIG [opciones]”, en el que CONFIG es el nombre de la configuración integrada o una ruta de acceso a un archivo de configuración en formato XML.
Parámetros | |
---|---|
arrayArgs |
String : Son los argumentos de la línea de comandos. |
unconsumedArgs |
: Una lista que se propagará con los argumentos que no se
que consumen los objetos asociados con la configuración especificada. Si esta
es null , la implementación arrojará
Es 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 tienen
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 de null
. Por lo tanto, arrojará ConfigurationException
si
se mantienen los argumentos no consumidos.
Parámetros | |
---|---|
arrayArgs |
String |
Muestra | |
---|---|
IConfiguration |
Arroja | |
---|---|
ConfigurationException |
createGlobalConfigurationFromArgs
public IGlobalConfiguration createGlobalConfigurationFromArgs (String[] arrayArgs,remainingArgs)
Crea un IGlobalConfiguration
a partir de los argumentos de la línea de comandos.
El formato esperado es “CONFIG [opciones]”, donde CONFIG es el nombre de la configuración integrada o una ruta de acceso a un archivo de configuración en formato XML.
Parámetros | |
---|---|
arrayArgs |
String : Son los argumentos de la línea de comandos. |
remainingArgs |
: Una lista que se completará con los argumentos que no se
procesados como argumentos globales |
Muestra | |
---|---|
IGlobalConfiguration |
el IGlobalConfiguration cargado. Los campos Option del objeto delegado
se completaron 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 : Es un IKeyStoreClient que se usa para obtener información sensible en el
args. |
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)
Vuelca 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) en el que se volcará el resultado. |
getConfigList
publicgetConfigList (String subPath, boolean loadFromEnv)
Variación de getConfigList()
en la que se puede especificar si también queremos cargar o no
la configuración del entorno.
Parámetros | |
---|---|
subPath |
String : Es el nombre de los subdirectorios que se buscarán para 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 configuración, por lo que es posible tener una configuración que no funcione. 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 ruta de clase y de 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 comprueba que todas las configuraciones se puedan cargar, analizar y todos los valores de opción establecidos. Solo se expusieron para que, dependiendo del proyecto, puedan validar sus parámetros de configuración. No se debe exponer en la consola.
Arroja | |
---|---|
ConfigurationException |
si no se pudieron cargar una o más configuraciones |
Ayudadeimprimir
public void printHelp (PrintStream out)
Imprime la salida de ayuda de la fábrica.
Imprime información genérica de ayuda y enumera todas las configuraciones disponibles.
Parámetros | |
---|---|
out |
PrintStream : Es el ERROR(/PrintStream) en el 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
de XML, y se mostrará la ayuda para ese IConfiguration
. Ten en cuenta todos los demás “args”
valores se ignorarán (es decir, el texto de ayuda describirá los valores actuales de Option
s)
como se carguen desde XML y no reflejará los valores de las opciones establecidos por los argumentos de la línea de comandos.
Si 'args' no hace referencia a un elemento IConfiguration
conocido, el elemento
Se mostrará la ayuda de printHelp(PrintStream)
.
Parámetros | |
---|---|
args |
String : Son los argumentos de la línea de comandos. |
importantOnly |
boolean : Si es true , imprime una ayuda abreviada que enumere solo los
detalles importantes |
out |
PrintStream : Es el ERROR(/PrintStream) en el que se volcará el resultado. |
Métodos protegidos
getBundledConfigStream.
protected InputStream getBundledConfigStream (String name)
Parámetros | |
---|---|
name |
String |
Muestra | |
---|---|
InputStream |
getConfigPrefix
protected String getConfigPrefix ()
Devuelve el prefijo de ruta de acceso de los archivos de configuración en formato XML en la ruta de clase
Está expuesto para que las pruebas de unidades puedan simular.
Muestra | |
---|---|
String |
Ruta de String con una / al 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 la configuración |
Arroja | |
---|---|
ConfigurationException |
si no se encuentra la configuración |
getConfigurationDef.
protected ConfigurationDef getConfigurationDef (String name, boolean isGlobal,templateMap)
Recupera los ConfigurationDef
del nombre dado
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.
para cargar |
isGlobal |
boolean |
templateMap |
|
Muestra | |
---|---|
ConfigurationDef |
ConfigurationDef |
Arroja | |
---|---|
ConfigurationException |
Si se produjo un error cuando se cargaba la configuración |
getMapConfig
protectedgetMapConfig ()
Expuesto para realizar pruebas. Muestra una copia del mapa.
Muestra | |
---|---|
|
isDirectConfiguration
protected boolean isDirectConfiguration (String configName)
Parámetros | |
---|---|
configName |
String |
Muestra | |
---|---|
boolean |
reordenarArgs
protected String[] reorderArgs (String[] args)
Reordena los argumentos de modo que los argumentos template:map se muevan al frente.
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 |