IConfigurationFactory

public interface IConfigurationFactory

com.android.tradefed.config.IConfigurationFactory


Fábrica para crear IConfiguration

Resumen

Métodos públicos

abstract IConfiguration createConfigurationFromArgs(String[] args, unconsumedArgs)

Crea el IConfiguration a partir de argumentos de línea de comandos.

abstract IConfiguration createConfigurationFromArgs(String[] args)

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

abstract IConfiguration createConfigurationFromArgs(String[] args, unconsumedArgs, IKeyStoreClient keyStoreClient)

Crea el IConfiguration a partir de los argumentos de la línea de comandos con un almacén de claves.

abstract IGlobalConfiguration createGlobalConfigurationFromArgs(String[] args, nonGlobalArgs)

Crea un IGlobalConfiguration a partir de argumentos de línea de comandos.

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

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

abstract void dumpConfig(String configName, PrintStream out)

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

abstract getConfigList()

Muestra la lista de nombres de todas las configuraciones que se encuentran en los archivos JAR de la ruta de clase.

abstract getConfigList(String subPath, boolean loadFromEnv)

Variación de getConfigList() en la que se puede especificar si también queremos cargar la configuración desde el entorno.

abstract void printHelp(PrintStream out)

Imprime el resultado de ayuda de esta fábrica.

abstract 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.

Métodos públicos

createConfigurationFromArgs

public abstract IConfiguration createConfigurationFromArgs (String[] args, 
                 unconsumedArgs)

Crea el IConfiguration a partir de los argumentos de la 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
args String: Los argumentos de la línea de comandos

unconsumedArgs : 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 si no se pudo cargar la configuración

createConfigurationFromArgs

public abstract IConfiguration createConfigurationFromArgs (String[] args)

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
args String

Muestra
IConfiguration

Arroja
ConfigurationException

createConfigurationFromArgs

public abstract IConfiguration createConfigurationFromArgs (String[] args, 
                 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 [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
args 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: Es 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 if configuration could not be loaded

createGlobalConfigurationFromArgs

public abstract IGlobalConfiguration createGlobalConfigurationFromArgs (String[] args, 
                 nonGlobalArgs)

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
args String: Son los argumentos de la línea de comandos.

nonGlobalArgs : 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 si no se pudo cargar la configuración

createPartialConfigurationFromArgs

public abstract 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 if configuration could not be loaded

dumpConfig

public abstract 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

public abstract  getConfigList ()

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

getConfigList

public abstract  getConfigList (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

printHelp

public abstract void printHelp (PrintStream out)

Imprime el resultado de ayuda de esta fábrica.

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

Parámetros
out PrintStream: Es el ERROR(/PrintStream) al que se volcará el resultado.

printHelpForConfig

public abstract 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) en el que se volcará el resultado.