IConfigurationFactory

public interface IConfigurationFactory

com.android.tradefed.config.IConfigurationFactory


Fabryka tworzenia IConfiguration

Podsumowanie

Metody publiczne

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

Utwórz IConfiguration z argumentów wiersza poleceń za pomocą magazynu kluczy.

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

Utwórz IConfiguration z argumentów wiersza poleceń.

abstract IConfiguration createConfigurationFromArgs(String[] args)

Metoda pomocnicza, która wywołuje funkcję createConfigurationFromArgs(String[],List) z argumentem null.

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

Utwórz IGlobalConfiguration z argumentów wiersza poleceń.

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

Utwórz konfigurację, która zawiera tylko zestaw wybranych obiektów.

abstract void dumpConfig(String configName, PrintStream out)

Zrzuca zawartość konfiguracji do podanego PrintStream

abstract List<String> getConfigList()

Zwraca listę nazw wszystkich konfiguracji znalezionych w plikach JAR na ścieżce klasy.

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

Wariant funkcji getConfigList(), w którym można określić, czy konfiguracja ma być wczytywana ze środowiska.

abstract void printHelp(PrintStream out)

Drukuje tekst pomocy dla tej fabryki.

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

Wyświetla dane wyjściowe pomocy dotyczące IConfiguration określonego w argumentach wiersza poleceń.

Jeśli argument „args” odnosi się do znanej konfiguracji, zostanie utworzony obiekt IConfiguration z XML i wyświetlona pomoc dotycząca tego obiektu IConfiguration.

Metody publiczne

createConfigurationFromArgs

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

Utwórz IConfiguration z argumentów wiersza poleceń za pomocą magazynu kluczy.

Oczekiwany format to „CONFIG [options]”, gdzie CONFIG to nazwa wbudowanej konfiguracji lub ścieżka do pliku XML konfiguracji.

Parametry
args String: argumenty wiersza poleceń

unconsumedArgs List: lista, która zostanie wypełniona argumentami, które nie zostały wykorzystane przez obiekty powiązane z określoną konfiguracją. Jeśli wartość tego parametru to null, implementacja zgłosi błąd ConfigurationException, jeśli pozostaną nieprzetworzone argumenty.

keyStoreClient IKeyStoreClient: IKeyStoreClient, który służy do uzyskiwania informacji poufnych w argumentach.

Zwraca
IConfiguration wczytany plik IConfiguration. Pola obiektu delegowanego Option zostały wypełnione wartościami w args.

Zgłasza
ConfigurationException jeśli nie udało się wczytać konfiguracji.

createConfigurationFromArgs

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

Utwórz IConfiguration z argumentów wiersza poleceń.

Oczekiwany format to „CONFIG [options]”, gdzie CONFIG to nazwa wbudowanej konfiguracji lub ścieżka do pliku XML konfiguracji.

Parametry
args String: argumenty wiersza poleceń

unconsumedArgs List: lista, która zostanie wypełniona argumentami, które nie zostały wykorzystane przez obiekty powiązane z określoną konfiguracją. Jeśli wartość tego parametru to null, implementacja zgłosi błąd ConfigurationException, jeśli pozostaną nieprzetworzone argumenty.

Zwraca
IConfiguration wczytany plik IConfiguration. Pola obiektu delegowanego Option zostały wypełnione wartościami w args.

Zgłasza
ConfigurationException jeśli nie udało się wczytać konfiguracji.

createConfigurationFromArgs

public abstract IConfiguration createConfigurationFromArgs (String[] args)

Metoda pomocnicza, która wywołuje funkcję createConfigurationFromArgs(String[],List) z argumentem null. Dlatego w przypadku pozostawienia nieużytych argumentów funkcja zgłosi wyjątek ConfigurationException.

Parametry
args String

Zwraca
IConfiguration

Zgłasza
ConfigurationException

createGlobalConfigurationFromArgs

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

Utwórz IGlobalConfiguration z argumentów wiersza poleceń.

Oczekiwany format to „CONFIG [options]”, gdzie CONFIG to nazwa wbudowanej konfiguracji lub ścieżka do pliku XML konfiguracji.

Parametry
args String: argumenty wiersza poleceń

nonGlobalArgs List: lista, która zostanie wypełniona argumentami, które nie zostały przetworzone jako argumenty globalne

Zwraca
IGlobalConfiguration wczytany plik IGlobalConfiguration. Pola obiektu delegowanego Option zostały wypełnione wartościami w args.

Zgłasza
ConfigurationException jeśli nie udało się wczytać konfiguracji.

createPartialConfigurationFromArgs

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

Utwórz konfigurację, która zawiera tylko zestaw wybranych obiektów.

Parametry
arrayArgs String: argumenty wiersza poleceń

keyStoreClient IKeyStoreClient: IKeyStoreClient, który służy do uzyskiwania informacji poufnych w argumentach.

allowedObjects Set: zestaw dozwolonych obiektów do utworzenia

delegator TradefedDelegator

Zwraca
IConfiguration Wczytany IConfiguration.

Zgłasza
ConfigurationException jeśli nie udało się wczytać konfiguracji.

dumpConfig

public abstract void dumpConfig (String configName, 
                PrintStream out)

Zrzuca zawartość konfiguracji do podanego PrintStream

Parametry
configName String: nazwa konfiguracji

out PrintStream: PrintStream, do którego ma być przekierowane wyjście

getConfigList

public abstract List<String> getConfigList ()

Zwraca listę nazw wszystkich konfiguracji znalezionych w plikach JAR na ścieżce klasy. Nie próbuje wczytać żadnej z konfiguracji, więc na tej liście może znajdować się nieprawidłowa konfiguracja.

Zwraca
List<String>

getConfigList

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

Wariant funkcji getConfigList(), w którym można określić, czy konfiguracja ma być wczytywana ze środowiska.

Parametry
subPath String: nazwy podkatalogów, w których należy szukać konfiguracji. Jeśli wartość to null, działanie będzie takie samo jak w przypadku wartości getConfigList().

loadFromEnv boolean: wartość „true”, jeśli konfiguracja ma być wczytana ze zmiennej środowiskowej.

Zwraca
List<String>

printHelp

public abstract void printHelp (PrintStream out)

Drukuje tekst pomocy dla tej fabryki.

Wyświetla ogólne informacje pomocy i listę wszystkich dostępnych konfiguracji.

Parametry
out PrintStream: PrintStream, do którego ma być przekierowane wyjście

printHelpForConfig

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

Wyświetla dane wyjściowe pomocy dotyczące IConfiguration określonego w argumentach wiersza poleceń.

Jeśli argument „args” odnosi się do znanej konfiguracji, zostanie utworzony obiekt IConfiguration z XML i wyświetlona pomoc dotycząca tego obiektu IConfiguration. Pamiętaj, że wszystkie inne wartości „args” zostaną zignorowane (np. tekst pomocy będzie opisywać bieżące wartości Options wczytane z pliku XML i nie będzie odzwierciedlać wartości opcji ustawionych przez argumenty wiersza poleceń.

Jeśli argument „args” nie odwołuje się do znanego IConfiguration, wyświetli się ogólna pomoc printHelp(PrintStream).

Parametry
args String: argumenty wiersza poleceń

importantOnly boolean: jeśli true, wydrukuj skróconą listę pomocy zawierającą tylko ważne szczegóły.

out PrintStream: PrintStream, do którego ma być przekierowane wyjście