IConfigurationFactory

public interface IConfigurationFactory

com.android.tradefed.config.IConfigurationFactory


Fábrica para crear IConfigurations

Resumen

Métodos públicos

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

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

abstract IConfiguration createConfigurationFromArgs(String[] args, List<String> unconsumedArgs)

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

abstract IConfiguration createConfigurationFromArgs(String[] args)

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

abstract IGlobalConfiguration createGlobalConfigurationFromArgs(String[] args, List<String> nonGlobalArgs)

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

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

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

abstract void dumpConfig(String configName, PrintStream out)

Volca el contenido de la configuración en el PrintStream determinado

abstract List<String> getConfigList()

Devuelve la lista de nombres de todos los parámetros de configuración que se encuentran en los archivos JAR de la ruta de acceso a la clase.

abstract List<String> 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 del entorno.

abstract void printHelp(PrintStream out)

Imprime el resultado de ayuda para 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 generará ayuda para ese IConfiguration.

Métodos públicos

createConfigurationFromArgs

public abstract IConfiguration createConfigurationFromArgs (String[] args, 
                List<String> unconsumedArgs, 
                IKeyStoreClient keyStoreClient)

Crea el objeto 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 la configuración integrada o una ruta de acceso a un archivo XML de configuración.

Parámetros
args String: Los argumentos de la línea de comandos

unconsumedArgs List: Es una lista que se completará 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 IConfiguration cargado. Los campos del objeto delegado Option se propagaron con valores en args.

Arroja
ConfigurationException Si no se pudo cargar la configuración

createConfigurationFromArgs

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

Crea el IConfiguration a partir de argumentos de 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 XML de configuración.

Parámetros
args String: Los argumentos de la línea de comandos

unconsumedArgs List: Es una lista que se completará 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 IConfiguration cargado. Los campos del objeto delegado Option se propagaron con valores en args.

Arroja
ConfigurationException Si no se pudo cargar la configuración

createConfigurationFromArgs

public abstract IConfiguration createConfigurationFromArgs (String[] args)

Es un método de conveniencia que llama a createConfigurationFromArgs(String[],List) con un segundo argumento null. Por lo tanto, arrojará ConfigurationException si quedan argumentos sin consumir.

Parámetros
args String

Muestra
IConfiguration

Arroja
ConfigurationException

createGlobalConfigurationFromArgs

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

Crea un IGlobalConfiguration a partir de argumentos de 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 XML de configuración.

Parámetros
args String: Los argumentos de la línea de comandos

nonGlobalArgs List: Es una lista que se completará con los argumentos que no se procesaron como argumentos globales.

Muestra
IGlobalConfiguration IGlobalConfiguration cargado. Los campos del objeto delegado Option 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, 
                Set<String> 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 los argumentos.

allowedObjects Set: Es el conjunto de objetos permitidos que se pueden crear.

delegator TradefedDelegator

Muestra
IConfiguration Es el objeto IConfiguration cargado.

Arroja
ConfigurationException Si no se pudo cargar la configuración

dumpConfig

public abstract void dumpConfig (String configName, 
                PrintStream out)

Volca el contenido de la configuración en el PrintStream determinado

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

out PrintStream: El PrintStream en el que se volcará el resultado

getConfigList

public abstract List<String> getConfigList ()

Devuelve la lista de nombres de todos los parámetros de configuración que se encuentran en los archivos JAR de la ruta de acceso a la clase. No intenta cargar ninguna de las configuraciones, por lo que es posible que haya configuraciones que no funcionen en esta lista.

Muestra
List<String>

getConfigList

public abstract List<String> 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 del 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
List<String>

printHelp

public abstract void printHelp (PrintStream out)

Imprime el resultado de ayuda para esta fábrica.

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

Parámetros
out PrintStream: El PrintStream en el 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 generará 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 Options cargados 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 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 lista de ayuda abreviada que solo incluya los detalles importantes.

out PrintStream: El PrintStream en el que se volcará el resultado