ConfigurationFactory

public class ConfigurationFactory
extends Object implements IConfigurationFactory

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

Fábrica para criar IConfiguration.

Resumo

Classes aninhadas

class ConfigurationFactory.ConfigLoader

Implementação de IConfigDefLoader que rastreia as configurações incluídas de uma configuração raiz e gera uma exceção em inclusões circulares. 

Construtores protegidos

ConfigurationFactory()

Métodos públicos

void clearMapConfig()

Em alguns casos, precisamos limpar o mapa.

IConfiguration createConfigurationFromArgs(String[] arrayArgs, unconsumedArgs)

Crie o IConfiguration usando argumentos da linha de comando.

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

Crie o IConfiguration a partir de argumentos de linha de comando com um repositório de chaves.

IConfiguration createConfigurationFromArgs(String[] arrayArgs)

Um método de conveniência que chama ERROR(/#createConfigurationFromArgs(String[],List)) com um segundo argumento null.

IGlobalConfiguration createGlobalConfigurationFromArgs(String[] arrayArgs, remainingArgs)

Crie um IGlobalConfiguration com base nos argumentos da linha de comando.

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

Crie uma configuração que contenha apenas um conjunto de objetos selecionados.

void dumpConfig(String configName, PrintStream out)

Transfere o conteúdo da configuração para o ERROR(/PrintStream) fornecido

getConfigList(String subPath, boolean loadFromEnv)

Variação de getConfigList() em que podemos especificar se também queremos carregar a configuração do ambiente.

getConfigList()

Retorna a lista de nomes de todas as configurações encontradas nos JARs no caminho de classe.

static IConfigurationFactory getInstance()

Receba a instância de singleton IConfigurationFactory.

void loadAllConfigs(boolean discardExceptions)

Carrega todas as configurações encontradas nos diretórios de casos de teste e de classpath.

void loadAndPrintAllConfigs()

Método utilitário que verifica se todas as configurações podem ser carregadas, analisadas e todos os valores de opções definidos.

void printHelp(PrintStream out)

Imprime a saída de ajuda para essa fábrica.

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

Mostra a saída de ajuda para o IConfiguration especificado nos argumentos da linha de comando.

Se "args" se referir a uma configuração conhecida, um objeto IConfiguration será criado a partir do XML, e a ajuda para IConfiguration será gerada.

Métodos protegidos

InputStream getBundledConfigStream(String name)
String getConfigPrefix()

Retorna o prefixo de caminho dos arquivos XML de configuração no classpath

Exposição para que os testes de unidade possam simular.

BufferedInputStream getConfigStream(String name)

Carrega um InputStream para o nome de configuração fornecido

ConfigurationDef getConfigurationDef(String name, boolean isGlobal, templateMap)

Extrair o ConfigurationDef para o nome fornecido

getMapConfig()

Exposto para testes.

String[] reorderArgs(String[] args)

Reorganize os argumentos para que os argumentos template:map sejam todos movidos para a frente.

Construtores protegidos

ConfigurationFactory

protected ConfigurationFactory ()

Métodos públicos

clearMapConfig

public void clearMapConfig ()

Em alguns casos, precisamos limpar o mapa.

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs, 
                 unconsumedArgs)

Crie o IConfiguration usando argumentos da linha de comando.

O formato esperado é "CONFIG [options]", em que CONFIG é o nome da configuração integrada ou um caminho de arquivo para um arquivo XML de configuração.

Parâmetros
arrayArgs String: os argumentos da linha de comando
unconsumedArgs : uma lista que será preenchida com os argumentos que não foram consumidos pelos objetos associados à configuração especificada. Se esse valor for null, a implementação vai gerar ConfigurationException se algum argumento não processado permanecer.
Retorna
IConfiguration o IConfiguration carregado. Os campos Option do objeto delegado foram preenchidos com valores em args.
Gera
ConfigurationException

createConfigurationFromArgs

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

Crie o IConfiguration a partir de argumentos de linha de comando com um repositório de chaves.

O formato esperado é "CONFIG [options]", em que CONFIG é o nome da configuração integrada ou um caminho de arquivo para um arquivo XML de configuração.

Parâmetros
arrayArgs String: os argumentos da linha de comando
unconsumedArgs : uma lista que será preenchida com os argumentos que não foram consumidos pelos objetos associados à configuração especificada. Se esse valor for null, a implementação vai gerar ConfigurationException se algum argumento não processado permanecer.
keyStoreClient IKeyStoreClient: um IKeyStoreClient usado para extrair informações sensíveis nos argumentos.
Retorna
IConfiguration o IConfiguration carregado. Os campos Option do objeto delegado foram preenchidos com valores em args.
Gera
ConfigurationException

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs)

Um método de conveniência que chama ERROR(/#createConfigurationFromArgs(String[],List)) com um segundo argumento null. Assim, ele vai gerar ConfigurationException se algum argumento não consumido permanecer.

Parâmetros
arrayArgs String

Retorna
IConfiguration

Gera
ConfigurationException

createGlobalConfigurationFromArgs

public IGlobalConfiguration createGlobalConfigurationFromArgs (String[] arrayArgs, 
                 remainingArgs)

Crie um IGlobalConfiguration com base nos argumentos da linha de comando.

O formato esperado é "CONFIG [options]", em que CONFIG é o nome da configuração integrada ou um caminho de arquivo para um arquivo XML de configuração.

Parâmetros
arrayArgs String: os argumentos da linha de comando
remainingArgs : uma lista que será preenchida com os argumentos que não foram processados como globais
Retorna
IGlobalConfiguration o IGlobalConfiguration carregado. Os campos Option do objeto delegado foram preenchidos com valores em args.
Gera
ConfigurationException

createPartialConfigurationFromArgs

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

Crie uma configuração que contenha apenas um conjunto de objetos selecionados.

Parâmetros
arrayArgs String: os argumentos da linha de comando
keyStoreClient IKeyStoreClient: um IKeyStoreClient usado para receber informações sensíveis nos argumentos.
allowedObjects : o conjunto de objetos permitidos a serem criados
Retorna
IConfiguration O IConfiguration carregado.
Gera
ConfigurationException

dumpConfig

public void dumpConfig (String configName, 
                PrintStream out)

Transfere o conteúdo da configuração para o ERROR(/PrintStream) fornecido

Parâmetros
configName String: o nome da configuração
out PrintStream: o ERROR(/PrintStream) para despejar a saída

getConfigList

public  getConfigList (String subPath, 
                boolean loadFromEnv)

Variação de getConfigList() em que podemos especificar se também queremos carregar a configuração do ambiente.

Parâmetros
subPath String: nome dos subdiretórios em que procurar a configuração. Se for nulo, terá o mesmo comportamento de getConfigList().
loadFromEnv boolean: verdadeiro se for necessário carregar a configuração na variável de ambiente.

Retorna

getConfigList

public  getConfigList ()

Retorna a lista de nomes de todas as configurações encontradas nos JARs no caminho de classe. Não tenta carregar nenhuma das configurações. Portanto, é possível ter uma configuração que não funciona nesta lista.

Retorna

getInstance

public static IConfigurationFactory getInstance ()

Receba a instância de singleton IConfigurationFactory.

Retorna
IConfigurationFactory

loadAllConfigs

public void loadAllConfigs (boolean discardExceptions)

Carrega todas as configurações encontradas nos diretórios de casos de teste e de classpath.

Parâmetros
discardExceptions boolean: verdadeiro se qualquer ConfigurationException precisa ser ignorada.
Gera
ConfigurationException

loadAndPrintAllConfigs

public void loadAndPrintAllConfigs ()

Método utilitário que verifica se todas as configurações podem ser carregadas, analisadas e todos os valores de opções definidos. Apenas exposto para que o projeto dependente possa validar as configurações. Não deve ser exposto no console.

Gera
ConfigurationException se uma ou mais configurações falharem ao carregar

printHelp

public void printHelp (PrintStream out)

Imprime a saída de ajuda para essa fábrica.

Imprime informações genéricas de ajuda e lista todas as configurações disponíveis.

Parâmetros
out PrintStream: o ERROR(/PrintStream) para despejar a saída

printHelpForConfig

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

Mostra a saída de ajuda para o IConfiguration especificado nos argumentos da linha de comando.

Se "args" se referir a uma configuração conhecida, um objeto IConfiguration será criado a partir do XML, e a ajuda para IConfiguration será gerada. Todos os outros valores de 'args' serão ignorados. O texto de ajuda vai descrever os valores atuais de Options carregados do XML e não vai refletir os valores da opção definidos pelos argumentos de linha de comando.

Se "args" não fizer referência a uma IConfiguration conhecida, a ajuda genérica printHelp(PrintStream) será exibida.

Parâmetros
args String: os argumentos da linha de comando
importantOnly boolean: se true, mostra uma ajuda abreviada com apenas os detalhes importantes.
out PrintStream: o ERROR(/PrintStream) para despejar a saída

Métodos protegidos

getBundledConfigStream

protected InputStream getBundledConfigStream (String name)

Parâmetros
name String

Retorna
InputStream

getConfigPrefix

protected String getConfigPrefix ()

Retorna o prefixo de caminho dos arquivos XML de configuração no classpath

Exposição para que os testes de unidade possam simular.

Retorna
String Caminho String com / no final

getConfigStream

protected BufferedInputStream getConfigStream (String name)

Carrega um InputStream para o nome de configuração fornecido

Parâmetros
name String: o nome da configuração a ser carregada
Retorna
BufferedInputStream um ERROR(/BufferedInputStream) para ler o conteúdo da configuração
Gera
ConfigurationException if config could not be found

getConfigurationDef

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

Extrair o ConfigurationDef para o nome fornecido

Parâmetros
name String: o nome de uma configuração integrada a ser carregada ou um caminho de arquivo de configuração a ser carregado
isGlobal boolean

templateMap

Retorna
ConfigurationDef ConfigurationDef
Gera
ConfigurationException se ocorreu um erro ao carregar a configuração

getMapConfig

protected  getMapConfig ()

Exposto para testes. Retorna uma cópia do mapa.

Retorna

reorderArgs

protected String[] reorderArgs (String[] args)

Reorganize os argumentos para que os argumentos template:map sejam todos movidos para a frente.

Parâmetros
args String

Retorna
String[]