ConfigurationFactory

public class ConfigurationFactory
extends Object implements IConfigurationFactory

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

Fabryka do tworzenia IConfiguration.

Podsumowanie

Zagnieżdżone klasy

class ConfigurationFactory.ConfigLoader

Implementacja interfejsu IConfigDefLoader, która śledzi dołączone konfiguracje z jednej konfiguracji głównej i zgłasza wyjątek w przypadku dołączeń cyklicznych. 

class ConfigurationFactory.ExceptionLoader

 

Konstruktory chronione

ConfigurationFactory()

Metody publiczne

void clearMapConfig()

W niektórych przypadkach musimy wyczyścić mapę.

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

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

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

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

IConfiguration createConfigurationFromArgs(String[] arrayArgs)

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

IGlobalConfiguration createGlobalConfigurationFromArgs(String[] arrayArgs, List<String> remainingArgs)

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

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

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

void dumpConfig(String configName, PrintStream out)

Zrzuca zawartość konfiguracji do podanego PrintStream

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

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

List<String> getConfigList()

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

static IConfigurationFactory getInstance()

Pobierz instancję klasy typu singleton IConfigurationFactory.

void loadAllConfigs(boolean discardExceptions)

Wczytuje wszystkie konfiguracje znalezione w ścieżce klasy i katalogach przypadków testowych.

void loadAndPrintAllConfigs()

Metoda narzędziowa, która sprawdza, czy wszystkie konfiguracje można wczytać i przeanalizować oraz czy można ustawić wszystkie wartości opcji.

void printHelp(PrintStream out)

Drukuje tekst pomocy dla tej fabryki.

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 chronione

InputStream getBundledConfigStream(String name)
String getConfigPrefix()

Zwraca prefiks ścieżki plików XML konfiguracji w ścieżce klasy.

Udostępniane, aby testy jednostkowe mogły je symulować.

BufferedInputStream getConfigStream(String name)

Wczytuje InputStream dla podanej nazwy konfiguracji

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

Pobierz ConfigurationDef dla podanej nazwy.

Map<ConfigurationFactory.ConfigId, ConfigurationDef> getMapConfig()

Udostępniono do testowania.

boolean isDirectConfiguration(String configName)
String[] reorderArgs(String[] args)

Zmień kolejność argumentów, tak aby argumenty template:map były na początku.

IRemoteFileResolver.ResolvedFile resolveRemoteFile(URI configURI, URI destDir)

Konstruktory chronione

ConfigurationFactory

protected ConfigurationFactory ()

Metody publiczne

clearMapConfig

public void clearMapConfig ()

W niektórych przypadkach musimy wyczyścić mapę.

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs, 
                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
arrayArgs 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

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs, 
                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
arrayArgs 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

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs)

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

Zwraca
IConfiguration

Zgłasza
ConfigurationException

createGlobalConfigurationFromArgs

public IGlobalConfiguration createGlobalConfigurationFromArgs (String[] arrayArgs, 
                List<String> remainingArgs)

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
arrayArgs String: argumenty wiersza poleceń
remainingArgs 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

createPartialConfigurationFromArgs

public 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

dumpConfig

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

getConfigList

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

getInstance

public static IConfigurationFactory getInstance ()

Pobierz instancję klasy typu singleton IConfigurationFactory.

Zwraca
IConfigurationFactory

loadAllConfigs

public void loadAllConfigs (boolean discardExceptions)

Wczytuje wszystkie konfiguracje znalezione w ścieżce klasy i katalogach przypadków testowych.

Parametry
discardExceptions boolean: wartość true, jeśli należy zignorować wyjątek ConfigurationException.
Zgłasza
com.android.tradefed.config.ConfigurationException
ConfigurationException

loadAndPrintAllConfigs

public void loadAndPrintAllConfigs ()

Metoda narzędziowa, która sprawdza, czy wszystkie konfiguracje można wczytać i przeanalizować oraz czy można ustawić wszystkie wartości opcji. Udostępniane tylko po to, aby projekt zależny mógł weryfikować swoje konfiguracje. Nie powinny być widoczne w konsoli.

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

printHelp

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

Metody chronione

getBundledConfigStream

protected InputStream getBundledConfigStream (String name)

Parametry
name String

Zwraca
InputStream

getConfigPrefix

protected String getConfigPrefix ()

Zwraca prefiks ścieżki plików XML konfiguracji w ścieżce klasy.

Udostępniane, aby testy jednostkowe mogły je symulować.

Zwraca
String String ścieżka ze znakiem „/” na końcu

getConfigStream

protected BufferedInputStream getConfigStream (String name)

Wczytuje InputStream dla podanej nazwy konfiguracji

Parametry
name String: nazwa konfiguracji do wczytania
Zwraca
BufferedInputStream BufferedInputStream do odczytywania zawartości konfiguracji,
Zgłasza
ConfigurationException jeśli nie udało się znaleźć konfiguracji.

getConfigurationDef

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

Pobierz ConfigurationDef dla podanej nazwy.

Parametry
name String: nazwa wbudowanej konfiguracji do wczytania lub ścieżka do pliku konfiguracji do wczytania.
isGlobal boolean

templateMap Map

Zwraca
ConfigurationDef ConfigurationDef
Zgłasza
ConfigurationException jeśli podczas wczytywania konfiguracji wystąpił błąd.

getMapConfig

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

Udostępniono do testowania. Zwróć kopię mapy.

Zwraca
Map<ConfigurationFactory.ConfigId, ConfigurationDef>

isDirectConfiguration

protected boolean isDirectConfiguration (String configName)

Parametry
configName String

Zwraca
boolean

reorderArgs

protected String[] reorderArgs (String[] args)

Zmień kolejność argumentów, tak aby argumenty template:map były na początku.

Parametry
args String

Zwraca
String[]

resolveRemoteFile

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

Parametry
configURI URI

destDir URI

Zwraca
IRemoteFileResolver.ResolvedFile

Zgłasza
BuildRetrievalError