Fábrica de configuración

public class ConfigurationFactory
extends Object implements IConfigurationFactory

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

Factory 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 genera una excepción en las inclusiones circulares.

class ConfigurationFactory.ExceptionLoader

Constructores protegidos

ConfigurationFactory ()

Métodos públicos

void clearMapConfig ()

En algún caso particular, necesitamos despejar el mapa.

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

Cree IConfiguration a partir de argumentos de línea de comandos.

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

Cree IConfiguration a partir de argumentos de línea de comandos con un almacén de claves.

IConfiguration createConfigurationFromArgs (String[] arrayArgs)

Un método conveniente que llama ERROR(/#createConfigurationFromArgs(String[],List)) con un segundo argumento null .

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

Cree una IGlobalConfiguration a partir de argumentos de la línea de comandos.

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

Cree una configuración que solo contenga un conjunto de objetos seleccionados.

void dumpConfig (String configName, PrintStream out)

Vuelca el contenido de la configuración al ERROR(/PrintStream)

getConfigList (String subPath, boolean loadFromEnv)

Variación de getConfigList() donde podemos especificar si queremos o no cargar también la configuración del entorno.

getConfigList ()

Devuelve la lista de nombres de todas las configuraciones encontradas en los JAR en el classpath.

static IConfigurationFactory getInstance ()

Obtenga la instancia IConfigurationFactory singleton.

void loadAllConfigs (boolean discardExceptions)

Carga todas las configuraciones que se encuentran en los directorios classpath y test cases.

void loadAndPrintAllConfigs ()

Método de utilidad que comprueba que todas las configuraciones se pueden cargar, analizar y establecer todos los valores de las opciones.

void printHelp (PrintStream out)

Imprime la salida de ayuda para esta fábrica.

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

Imprime la salida de ayuda para la IConfiguration especificada en los argumentos de la línea de comando,

Si 'args' hace referencia a una configuración conocida, se creará un objeto IConfiguration a partir de XML y se generará ayuda para esa IConfiguration .

Métodos protegidos

InputStream getBundledConfigStream (String name)
String getConfigPrefix ()

Devuelve el prefijo de ruta de los archivos xml de configuración en classpath

Expuesto para que las pruebas unitarias puedan simular.

BufferedInputStream getConfigStream (String name)

Carga un InputStream para el nombre de configuración dado

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

Recuperar ConfigurationDef para el nombre dado

getMapConfig ()

Expuesto para la prueba.

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

Reordene los argumentos para que los argumentos template:map se muevan al frente.

IRemoteFileResolver.ResolvedFile resolveRemoteFile (URI configURI, URI destDir)

Constructores protegidos

Fábrica de configuración

protected ConfigurationFactory ()

Métodos públicos

clearMapConfig

public void clearMapConfig ()

En algún caso particular, necesitamos despejar el mapa.

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs, 
                 unconsumedArgs)

Cree IConfiguration a partir de argumentos de línea de comando.

El formato esperado es "CONFIG [opciones]", donde CONFIG es el nombre de configuración incorporado o una ruta de archivo a un archivo xml de configuración.

Parámetros
arrayArgs String : los argumentos de la línea de comando

unconsumedArgs : una lista que se completará con los argumentos que no fueron consumidos por los objetos asociados con la configuración especificada. Si esto es null , entonces la implementación lanzará ConfigurationException si quedan argumentos sin procesar.

Devoluciones
IConfiguration la IConfiguration cargada. Los campos Option del objeto delegado se han rellenado con valores en args.

Lanza
ConfigurationException

createConfigurationFromArgs

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

Cree IConfiguration a partir de argumentos de línea de comandos con un almacén de claves.

El formato esperado es "CONFIG [opciones]", donde CONFIG es el nombre de configuración incorporado o una ruta de archivo a un archivo xml de configuración.

Parámetros
arrayArgs String : los argumentos de la línea de comando

unconsumedArgs : una lista que se completará con los argumentos que no fueron consumidos por los objetos asociados con la configuración especificada. Si esto es null , entonces la implementación lanzará ConfigurationException si quedan argumentos sin procesar.

keyStoreClient IKeyStoreClient : un IKeyStoreClient que se usa para obtener información confidencial en los argumentos.

Devoluciones
IConfiguration la IConfiguration cargada. Los campos Option del objeto delegado se han rellenado con valores en args.

Lanza
ConfigurationException

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs)

Un método conveniente que llama ERROR(/#createConfigurationFromArgs(String[],List)) con un segundo argumento null . Por lo tanto, arrojará ConfigurationException si quedan argumentos no consumidos.

Parámetros
arrayArgs String

Devoluciones
IConfiguration

Lanza
ConfigurationException

createGlobalConfigurationFromArgs

public IGlobalConfiguration createGlobalConfigurationFromArgs (String[] arrayArgs, 
                 remainingArgs)

Cree una IGlobalConfiguration a partir de argumentos de la línea de comandos.

El formato esperado es "CONFIG [opciones]", donde CONFIG es el nombre de configuración incorporado o una ruta de archivo a un archivo xml de configuración.

Parámetros
arrayArgs String : los argumentos de la línea de comando

remainingArgs : una lista que se completará con los argumentos que no se procesaron como argumentos globales

Devoluciones
IGlobalConfiguration la IGlobalConfiguration cargada. Los campos Option del objeto delegado se han rellenado con valores en args.

Lanza
ConfigurationException

createPartialConfigurationFromArgs

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

Cree una configuración que solo contenga un conjunto de objetos seleccionados.

Parámetros
arrayArgs String : Los argumentos de la línea de comando

keyStoreClient IKeyStoreClient : un IKeyStoreClient que se usa para obtener información confidencial en los argumentos.

allowedObjects : El conjunto de objetos permitidos para ser creados

delegator TradefedDelegator

Devoluciones
IConfiguration La IConfiguration cargada.

Lanza
ConfigurationException

dumpConfig

public void dumpConfig (String configName, 
                PrintStream out)

Vuelca el contenido de la configuración al ERROR(/PrintStream)

Parámetros
configName String : el nombre de la configuración

out PrintStream : el ERROR(/PrintStream) para volcar la salida a

getConfigList

public  getConfigList (String subPath, 
                boolean loadFromEnv)

Variación de getConfigList() donde podemos especificar si queremos o no cargar también la configuración del entorno.

Parámetros
subPath String : nombre de los subdirectorios en los que buscar la configuración. Si es nulo, tendrá el mismo comportamiento que getConfigList() .

loadFromEnv boolean : True si debemos cargar la configuración en la variable de entorno.

Devoluciones

getConfigList

public  getConfigList ()

Devuelve la lista de nombres de todas las configuraciones encontradas en los JAR en el classpath. No intenta cargar ninguna de las configuraciones, por lo que es posible que haya una configuración que no funcione en esta lista.

Devoluciones

obtener Instancia

public static IConfigurationFactory getInstance ()

Obtenga la instancia IConfigurationFactory singleton.

Devoluciones
IConfigurationFactory

cargar todas las configuraciones

public void loadAllConfigs (boolean discardExceptions)

Carga todas las configuraciones que se encuentran en los directorios classpath y test cases.

Parámetros
discardExceptions boolean : verdadero si se debe ignorar cualquier ConfigurationException.

Lanza
com.android.tradefed.config.ConfigurationException
ConfigurationException

cargar e imprimir todas las configuraciones

public void loadAndPrintAllConfigs ()

Método de utilidad que comprueba que todas las configuraciones se pueden cargar, analizar y establecer todos los valores de las opciones. Solo expuesto para que el proyecto dependiente pueda validar sus configuraciones. No debe estar expuesto en la consola.

Lanza
ConfigurationException si una o más configuraciones no se pudieron cargar

imprimirAyuda

public void printHelp (PrintStream out)

Imprime la salida de ayuda para esta fábrica.

Imprime una información de ayuda genérica y enumera todas las configuraciones disponibles.

Parámetros
out PrintStream : el ERROR(/PrintStream) para volcar la salida a

imprimirAyudaParaConfig

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

Imprime la salida de ayuda para la IConfiguration especificada en los argumentos de la línea de comando,

Si 'args' hace referencia a una configuración conocida, se creará un objeto IConfiguration a partir de XML y se generará ayuda para esa IConfiguration . Tenga 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 s tal como se cargaron desde XML, y no reflejará los valores de opción establecidos por la línea de comando args.

Si 'args' no hace referencia a una IConfiguration conocida, se mostrará la ayuda genérica printHelp(PrintStream) .

Parámetros
args String : los argumentos de la línea de comando

importantOnly boolean : si true , imprime una ayuda abreviada que enumera solo los detalles importantes

out PrintStream : el ERROR(/PrintStream) para volcar la salida a

Métodos protegidos

getBundledConfigStream

protected InputStream getBundledConfigStream (String name)

Parámetros
name String

Devoluciones
InputStream

getConfigPrefix

protected String getConfigPrefix ()

Devuelve el prefijo de ruta de los archivos xml de configuración en classpath

Expuesto para que las pruebas unitarias puedan simular.

Devoluciones
String Ruta String con final /

getConfigStream

protected BufferedInputStream getConfigStream (String name)

Carga un InputStream para el nombre de configuración dado

Parámetros
name String : el nombre de la configuración a cargar

Devoluciones
BufferedInputStream un ERROR(/BufferedInputStream) para leer el contenido de configuración

Lanza
ConfigurationException si no se pudo encontrar la configuración

getConfigurationDef

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

Recuperar ConfigurationDef para el nombre dado

Parámetros
name String : el nombre de una configuración integrada para cargar o una ruta de archivo al archivo de configuración para cargar

isGlobal boolean

templateMap

Devoluciones
ConfigurationDef ConfigurationDef

Lanza
ConfigurationException si ocurrió un error al cargar la configuración

getMapConfig

protected  getMapConfig ()

Expuesto para la prueba. Devolver una copia del Mapa.

Devoluciones

isDirectConfiguration

protected boolean isDirectConfiguration (String configName)

Parámetros
configName String

Devoluciones
boolean

reordenarArgs

protected String[] reorderArgs (String[] args)

Reordene los argumentos para que los argumentos template:map se muevan al frente.

Parámetros
args String

Devoluciones
String[]

resolverRemoteFile

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

Parámetros
configURI URI

destDir URI

Devoluciones
IRemoteFileResolver.ResolvedFile

Lanza
BuildRetrievalError