IConfigurationFactory

public interface IConfigurationFactory

com.android.tradefed.config.IConfigurationFactory

Fábrica para criar IConfigurations

Resumo

Métodos públicos

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

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

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

Crie o IConfiguration usando argumentos da linha de comando.

abstract IConfiguration createConfigurationFromArgs(String[] args)

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

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

Crie um IGlobalConfiguration com argumentos da linha de comando.

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

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

abstract void dumpConfig(String configName, PrintStream out)

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

abstract List<String> getConfigList()

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

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

abstract void printHelp(PrintStream out)

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

abstract 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 públicos

createConfigurationFromArgs

public abstract IConfiguration createConfigurationFromArgs (String[] args, 
                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
args 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 se não for possível carregar a configuração

createConfigurationFromArgs

public abstract IConfiguration createConfigurationFromArgs (String[] args, 
                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
args 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 se não for possível carregar a configuração

createConfigurationFromArgs

public abstract IConfiguration createConfigurationFromArgs (String[] args)

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

Retorna
IConfiguration

Gera
ConfigurationException

createGlobalConfigurationFromArgs

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

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
args String: os argumentos da linha de comando
nonGlobalArgs 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 se não for possível carregar a configuração

createPartialConfigurationFromArgs

public abstract 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 se não for possível carregar a configuração

dumpConfig

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

getConfigList

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

printHelp

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