ConfigurationFactory

public class ConfigurationFactory
extends Object implements IConfigurationFactory

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

Subclasses diretas conhecidas GCSConfigurationFactory, RetryConfigurationFactory, SandboxConfigurationFactory GCSConfigurationFactory Um ConfigurationFactory carrega configurações do Google Cloud Storage.  RetryConfigurationFactory Fábrica que processa a nova tentativa de um comando.  SandboxConfigurationFactory Fábrica de configuração especial para lidar com a criação de configurações para fins de isolamento em sandbox.

---

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.
class	ConfigurationFactory.ExceptionLoader

Construtores protegidos
ConfigurationFactory()

Métodos públicos
void	clearMapConfig() Em alguns casos específicos, precisamos limpar o mapa.
IConfiguration	createConfigurationFromArgs(String[] arrayArgs, List<String> unconsumedArgs, IKeyStoreClient keyStoreClient) Crie o IConfiguration com argumentos de linha de comando e um keystore.
IConfiguration	createConfigurationFromArgs(String[] arrayArgs, List<String> unconsumedArgs) Crie o IConfiguration usando argumentos da linha de comando.
IConfiguration	createConfigurationFromArgs(String[] arrayArgs) Um método de conveniência que chama createConfigurationFromArgs(String[],List) com um segundo argumento null.
IGlobalConfiguration	createGlobalConfigurationFromArgs(String[] arrayArgs, List<String> remainingArgs) Crie um IGlobalConfiguration com argumentos da linha de comando.
IConfiguration	createPartialConfigurationFromArgs(String[] arrayArgs, IKeyStoreClient keyStoreClient, Set<String> allowedObjects, TradefedDelegator delegator) Crie uma configuração que contenha apenas um conjunto de objetos selecionados.
void	dumpConfig(String configName, PrintStream out) Despeja o conteúdo da configuração no PrintStream especificado.
List<String>	getConfigList(String subPath, boolean loadFromEnv) Variação de getConfigList() em que é possível especificar se também queremos carregar a configuração do ambiente.
List<String>	getConfigList() Retorna a lista de nomes de todas as configurações encontradas nos JARs no classpath.
static IConfigurationFactory	getInstance() Receba a instância singleton IConfigurationFactory.
void	loadAllConfigs(boolean discardExceptions) Carrega todas as configurações encontradas nos diretórios de classpath e casos de teste.
void	loadAndPrintAllConfigs() Método utilitário que verifica se todas as configurações podem ser carregadas, analisadas e se todos os valores de opção estão definidos.
void	printHelp(PrintStream out) Imprime a saída de ajuda para essa fábrica.
void	printHelpForConfig(String[] args, boolean importantOnly, PrintStream out) Imprime 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 em XML, e a ajuda para esse IConfiguration será gerada.

Métodos protegidos
InputStream	getBundledConfigStream(String name)
String	getConfigPrefix() Retorna o prefixo do caminho dos arquivos XML de configuração no classpath. Exposto para que os testes de unidade possam simular.
BufferedInputStream	getConfigStream(String name) Carrega um InputStream para o nome de configuração especificado.
ConfigurationDef	getConfigurationDef(String name, boolean isGlobal, Map<String, String> templateMap) Recuperar o ConfigurationDef para o nome especificado
Map<ConfigurationFactory.ConfigId, ConfigurationDef>	getMapConfig() Exposto para testes.
boolean	isDirectConfiguration(String configName)
String[]	reorderArgs(String[] args) Reordene os argumentos para que todos os argumentos template:map sejam movidos para a frente.
IRemoteFileResolver.ResolvedFile	resolveRemoteFile(URI configURI, URI destDir)

Construtores protegidos

ConfigurationFactory

protected ConfigurationFactory ()

Métodos públicos

clearMapConfig

public void clearMapConfig ()

Em alguns casos específicos, precisamos limpar o mapa.

createConfigurationFromArgs

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

Crie o IConfiguration com argumentos de linha de comando e um keystore.

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	List: uma lista que será preenchida com os argumentos que não foram consumidos pelos objetos associados à configuração especificada. Se for null, a implementação vai gerar ConfigurationException se ainda houver argumentos não processados.
keyStoreClient	IKeyStoreClient: um IKeyStoreClient usado para extrair informações sensíveis dos argumentos.

Retorna
IConfiguration	o IConfiguration carregado. Os campos do objeto delegado Option foram preenchidos com valores em args.

Gera
ConfigurationException

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs, 
                List<String> 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	List: uma lista que será preenchida com os argumentos que não foram consumidos pelos objetos associados à configuração especificada. Se for null, a implementação vai gerar ConfigurationException se ainda houver argumentos não processados.

Retorna
IConfiguration	o IConfiguration carregado. Os campos do objeto delegado Option foram preenchidos com valores em args.

Gera
ConfigurationException

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs)

Um método de conveniência que chama 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, 
                List<String> remainingArgs)

Crie um IGlobalConfiguration com 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	List: uma lista que será preenchida com os argumentos que não foram processados como argumentos globais.

Retorna
IGlobalConfiguration	o IGlobalConfiguration carregado. Os campos do objeto delegado Option foram preenchidos com valores em args.

Gera
ConfigurationException

createPartialConfigurationFromArgs

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

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 extrair informações sensíveis dos argumentos.
allowedObjects	Set: o conjunto de objetos permitidos a serem criados.
delegator	TradefedDelegator

Retorna
IConfiguration	O IConfiguration carregado.

Gera
ConfigurationException

dumpConfig

public void dumpConfig (String configName, 
                PrintStream out)

Despeja o conteúdo da configuração no PrintStream especificado.

Parâmetros
configName	String: o nome da configuração
out	PrintStream: o PrintStream para despejar a saída.

getConfigList

public List<String> getConfigList (String subPath, 
                boolean loadFromEnv)

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

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

Retorna
List<String>

getConfigList

public List<String> getConfigList ()

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

Retorna
List<String>

getInstance

public static IConfigurationFactory getInstance ()

Receba a instância singleton IConfigurationFactory.

Retorna
IConfigurationFactory

loadAllConfigs

public void loadAllConfigs (boolean discardExceptions)

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

Parâmetros
discardExceptions	boolean: "true" se qualquer ConfigurationException precisar ser ignorada.

Gera
	com.android.tradefed.config.ConfigurationException
ConfigurationException

loadAndPrintAllConfigs

public void loadAndPrintAllConfigs ()

Método utilitário que verifica se todas as configurações podem ser carregadas, analisadas e se todos os valores de opção estão definidos. Exposto apenas 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 não forem carregadas

printHelp

public void printHelp (PrintStream out)

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

Imprime uma informação de ajuda genérica e lista todas as configurações disponíveis.

Parâmetros
out	PrintStream: o PrintStream para despejar a saída.

printHelpForConfig

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

Imprime 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 em XML, e a ajuda para esse IConfiguration será gerada. Todos os outros valores de "args" serão ignorados. Ou seja, o texto de ajuda descreverá os valores atuais de Options carregados do XML e não refletirá os valores da opção definidos pelos argumentos da linha de comando.

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

Parâmetros
args	String: os argumentos da linha de comando
importantOnly	boolean: se true, imprima uma lista de ajuda abreviada com apenas os detalhes importantes
out	PrintStream: o 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 do caminho dos arquivos XML de configuração no classpath.

Exposto 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 especificado.

Parâmetros
name	String: o nome da configuração a ser carregada

Retorna
BufferedInputStream	um BufferedInputStream para ler o conteúdo da configuração

Gera
ConfigurationException	se a configuração não for encontrada

getConfigurationDef

protected ConfigurationDef getConfigurationDef (String name, 
                boolean isGlobal, 
                Map<String, String> templateMap)

Recuperar o ConfigurationDef para o nome especificado

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

Retorna
ConfigurationDef	ConfigurationDef

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

getMapConfig

protected Map<ConfigurationFactory.ConfigId, ConfigurationDef> getMapConfig ()

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

Retorna
Map<ConfigurationFactory.ConfigId, ConfigurationDef>

isDirectConfiguration

protected boolean isDirectConfiguration (String configName)

Parâmetros
configName	String

Retorna
boolean

reorderArgs

protected String[] reorderArgs (String[] args)

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

Parâmetros
args	String

Retorna
String[]

resolveRemoteFile

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

Parâmetros
configURI	URI
destDir	URI

Retorna
IRemoteFileResolver.ResolvedFile

Gera
BuildRetrievalError