Fabryka konfiguracji
public
class
ConfigurationFactory
extends Object
implements
IConfigurationFactory
java.lang.Object | |
↳ | com.android.tradefed.config.ConfigurationFactory |
Fabryka do utworzenia urządzenia IConfiguration
.
Podsumowanie
Zagnieżdżone klasy | |
---|---|
class |
ConfigurationFactory.ConfigLoader
Implementacja interfejsu IConfigDefLoader, który śledzi uwzględnione konfiguracje z jednego pliku konfiguracji głównej i wyrzuca wyjątek w przypadku pętli uwzględnień. |
class |
ConfigurationFactory.ExceptionLoader
|
Konstruktory chronione | |
---|---|
ConfigurationFactory()
|
Metody publiczne | |
---|---|
void
|
clearMapConfig()
W niektórych przypadkach musimy wyczyścić mapę. |
IConfiguration
|
createConfigurationFromArgs(String[] arrayArgs,
Utwórz obiekt |
IConfiguration
|
createConfigurationFromArgs(String[] arrayArgs,
Utwórz obiekt |
IConfiguration
|
createConfigurationFromArgs(String[] arrayArgs)
Dogodna metoda, która wywołuje funkcję |
IGlobalConfiguration
|
createGlobalConfigurationFromArgs(String[] arrayArgs,
Utwórz |
IConfiguration
|
createPartialConfigurationFromArgs(String[] arrayArgs, IKeyStoreClient keyStoreClient,
Utwórz konfigurację, która zawiera tylko zbiór wybranych obiektów. |
void
|
dumpConfig(String configName, PrintStream out)
Usuwa zawartość konfiguracji do określonego |
|
getConfigList(String subPath, boolean loadFromEnv)
Wariant |
|
getConfigList()
Zwraca listę nazw wszystkich konfiguracji znalezionych w plikach JAR na ścieżce klas. |
static
IConfigurationFactory
|
getInstance()
Pobieranie instancji pojedynczej |
void
|
loadAllConfigs(boolean discardExceptions)
Wczytuje wszystkie konfiguracje znalezione w katalogach ścieżki klasy i przypadków testowych. |
void
|
loadAndPrintAllConfigs()
Metoda sprawdzania, czy wszystkie konfiguracje można wczytać, przeanalizować ustawiono wszystkie wartości opcji. |
void
|
printHelp(PrintStream out)
Wypisuje informacje pomocy dla tej fabryki. |
void
|
printHelpForConfig(String[] args, boolean importantOnly, PrintStream out)
Wyświetla dane pomocy dotyczące
Jeśli argument „args” odwołuje się do znanej konfiguracji, z plików XML zostanie utworzony obiekt |
Chronione metody | |
---|---|
InputStream
|
getBundledConfigStream(String name)
|
String
|
getConfigPrefix()
Zwraca prefiks ścieżki plików konfiguracji XML w ścieżce klas. Wyeksponowane, aby można było je zasymulować w testach jednostkowych. |
BufferedInputStream
|
getConfigStream(String name)
Ładuje InputStream dla podanej nazwy konfiguracji. |
ConfigurationDef
|
getConfigurationDef(String name, boolean isGlobal,
Pobierz |
|
getMapConfig()
Przedstawione do testów. |
boolean
|
isDirectConfiguration(String configName)
|
String[]
|
reorderArgs(String[] args)
Zmień kolejność argumentów, tak aby wszystkie argumenty szablon:mapa zostały przeniesione na wierzch. |
IRemoteFileResolver.ResolvedFile
|
resolveRemoteFile(URI configURI, URI destDir)
|
Chronione konstruktory
ConfigurationFactory
protected ConfigurationFactory ()
Metody publiczne
ClearMapConfig
public void clearMapConfig ()
W niektórych przypadkach musimy wyczyścić mapę.
createConfigurationZ Args
public IConfiguration createConfigurationFromArgs (String[] arrayArgs,unconsumedArgs)
Utwórz IConfiguration
z argumentów wiersza poleceń.
Oczekiwany format to „KONFIGURUJ [opcje]”, gdzie CONFIG to nazwa konfiguracji wbudowanej lub ścieżki do pliku XML konfiguracji.
Parametry | |
---|---|
arrayArgs |
String : argumenty wiersza poleceń |
unconsumedArgs |
: lista, która zostanie wypełniona argumentami, które nie zostały
używane przez obiekty powiązane z określoną konfiguracją. Jeśli to pole jest null , implementacja wyrzuci ConfigurationException , jeśli pozostaną jakieś nieprzetworzone argumenty. |
Zwroty | |
---|---|
IConfiguration |
wczytano IConfiguration . Pola obiektu delegowana Option zostały wypełnione wartościami z argów. |
Rzuty | |
---|---|
ConfigurationException |
createConfigurationFromArgs
public IConfiguration createConfigurationFromArgs (String[] arrayArgs,unconsumedArgs, IKeyStoreClient keyStoreClient)
Utwórz IConfiguration
z argumentów wiersza poleceń za pomocą repozytorium kluczy.
Oczekiwany format to „CONFIG [opcje]”, gdzie CONFIG to wbudowana nazwa konfiguracji lub ścieżka do pliku konfiguracji XML.
Parametry | |
---|---|
arrayArgs |
String : argumenty wiersza poleceń |
unconsumedArgs |
: lista, która zostanie wypełniona argumentami, których nie wykorzystały Obiekty powiązane ze wskazaną konfiguracją. Jeśli to null , implementacja wyrzuci ConfigurationException , jeśli pozostaną jakieś nieprzetworzone argumenty. |
keyStoreClient |
IKeyStoreClient : IKeyStoreClient , który służy do uzyskiwania informacji poufnych w argumencie. |
Zwroty | |
---|---|
IConfiguration |
wczytano IConfiguration . Pola Option obiektu delegata zawierają
została wypełniona wartościami w argumentach. |
Rzuty | |
---|---|
ConfigurationException |
createConfigurationZ Args
public IConfiguration createConfigurationFromArgs (String[] arrayArgs)
Metoda ułatwiająca, która wywołuje ERROR(/#createConfigurationFromArgs(String[],List))
z drugim argumentem null
. Wyrzuca ConfigurationException
, jeśli
wszystkie niewykorzystane argumenty
Parametry | |
---|---|
arrayArgs |
String |
Zwroty | |
---|---|
IConfiguration |
Rzuty | |
---|---|
ConfigurationException |
createGlobalConfigurationFromArgs
public IGlobalConfiguration createGlobalConfigurationFromArgs (String[] arrayArgs,remainingArgs)
Utwórz IGlobalConfiguration
z argumentów wiersza poleceń.
Oczekiwany format to „CONFIG [opcje]”, gdzie CONFIG to wbudowana nazwa konfiguracji lub ścieżka do pliku XML konfiguracji.
Parametry | |
---|---|
arrayArgs |
String : argumenty wiersza poleceń |
remainingArgs |
: lista, która zostanie wypełniona argumentami, które nie zostały przetworzone jako argumenty globalne |
Zwroty | |
---|---|
IGlobalConfiguration |
załadowany IGlobalConfiguration . Pola obiektu delegowana Option zostały wypełnione wartościami z argów. |
Rzuty | |
---|---|
ConfigurationException |
createWersja częściowaZ Argów
public IConfiguration createPartialConfigurationFromArgs (String[] arrayArgs, IKeyStoreClient keyStoreClient,allowedObjects, TradefedDelegator delegator)
Utwórz konfigurację, która zawiera tylko zbiór wybranych obiektów.
Parametry | |
---|---|
arrayArgs |
String : argumenty wiersza poleceń. |
keyStoreClient |
IKeyStoreClient : IKeyStoreClient , który służy do uzyskiwania informacji poufnych w
argumentów. |
allowedObjects |
: zbiór obiektów, które można utworzyć |
delegator |
TradefedDelegator |
Zwroty | |
---|---|
IConfiguration |
Załadowany IConfiguration . |
Rzuty | |
---|---|
ConfigurationException |
dumpConfig
public void dumpConfig (String configName, PrintStream out)
Usuwa zawartość konfiguracji do określonego ERROR(/PrintStream)
Parametry | |
---|---|
configName |
String : nazwa konfiguracji |
out |
PrintStream : element ERROR(/PrintStream) , do którego mają zostać przesłane dane wyjściowe |
getConfigList,
publicgetConfigList (String subPath, boolean loadFromEnv)
Wariant getConfigList()
, w którym można określić, czy chcemy wczytać konfigurację ze środowiska.
Parametry | |
---|---|
subPath |
String : nazwa katalogów podrzędnych, w których należy szukać konfiguracji. Jeśli wartość null, będzie miała
działa tak samo jak getConfigList() . |
loadFromEnv |
boolean : wartość prawda, jeśli konfiguracja ma być ładowana do zmiennej środowiskowej. |
Zwroty | |
---|---|
|
getConfigList,
publicgetConfigList ()
Zwraca listę nazw wszystkich konfiguracji znalezionych w plikach JAR w ścieżce klasy. Nie próbuje wczytać żadnej konfiguracji, więc może istnieć niedziałająca konfiguracja na tej liście.
Zwroty | |
---|---|
|
getInstance
public static IConfigurationFactory getInstance ()
Pobieranie instancji pojedynczej IConfigurationFactory
.
Zwroty | |
---|---|
IConfigurationFactory |
loadAllConfigs,
public void loadAllConfigs (boolean discardExceptions)
Ładuje wszystkie konfiguracje znalezione w katalogach classpath i test cases.
Parametry | |
---|---|
discardExceptions |
boolean : true, jeśli którykolwiek wyjątek konfiguracji ma być ignorowany. |
Rzuty | |
---|---|
|
com.android.tradefed.config.ConfigurationException |
ConfigurationException |
loadAndPrintAllConfigs
public void loadAndPrintAllConfigs ()
Metoda pomocnicza, która sprawdza, czy można wczytać i analizować wszystkie konfiguracje oraz czy są ustawione wszystkie wartości opcji. Widoczne tylko, aby w zależności od projektu mógł sprawdzać swoje konfiguracje. Nie powinien być widoczny w konsoli.
Rzuty | |
---|---|
ConfigurationException |
jeśli nie udało się wczytać co najmniej jednej konfiguracji |
Pomoc do drukowania
public void printHelp (PrintStream out)
Wypisuje informacje pomocy dla tej fabryki.
Wyświetla ogólne informacje pomocy i wyświetla wszystkie dostępne konfiguracje.
Parametry | |
---|---|
out |
PrintStream : ERROR(/PrintStream) , do którego mają być zapisywane dane wyjściowe |
PrintHelpForConfig
public void printHelpForConfig (String[] args, boolean importantOnly, PrintStream out)
Wyświetla pomocnicze wyniki dla obiektu IConfiguration
określonego w argumentach wiersza poleceń,
Jeśli argument „args” odwołuje się do znanej konfiguracji, z plików XML zostanie utworzony obiekt IConfiguration
, a na wyjściu zostanie wyświetlona pomoc dotycząca tego obiektu. Pamiętaj, że wszystkie inne wartości w argumencie „args” będą ignorowane (czyli tekst pomocy będzie opisywać bieżące wartości Option
s
wczytane z pliku XML i nie będzie odzwierciedlać wartości opcji ustawionych w argumencie wiersza poleceń).
Jeśli argument „args” nie odwołuje się do znanego parametru IConfiguration
, wyświetli się ogólna pomoc dotycząca parametru printHelp(PrintStream)
.
Parametry | |
---|---|
args |
String : argumenty wiersza poleceń |
importantOnly |
boolean : jeśli true , wydrukuj skróconą pomoc zawierającą tylko ważne informacje |
out |
PrintStream : ERROR(/PrintStream) , do którego mają być zapisywane dane wyjściowe |
Metody chronione
getBundledConfigStream,
protected InputStream getBundledConfigStream (String name)
Parametry | |
---|---|
name |
String |
Zwroty | |
---|---|
InputStream |
getConfigPrefix,
protected String getConfigPrefix ()
Zwraca prefiks ścieżki plików konfiguracji XML w ścieżce klas.
Wyeksponowane, aby można było je zasymulować w testach jednostkowych.
Zwroty | |
---|---|
String |
Ścieżka String z końcowym znakiem / |
getConfigStream
protected BufferedInputStream getConfigStream (String name)
Ładuje InputStream dla podanej nazwy konfiguracji.
Parametry | |
---|---|
name |
String : nazwa konfiguracji do załadowania |
Zwroty | |
---|---|
BufferedInputStream |
ERROR(/BufferedInputStream) do odczytu zawartości konfiguracji. |
Rzuty | |
---|---|
ConfigurationException |
jeśli nie można znaleźć konfiguracji |
getConfigurationDef
protected ConfigurationDef getConfigurationDef (String name, boolean isGlobal,templateMap)
Pobierz ConfigurationDef
dla podanej nazwy.
Parametry | |
---|---|
name |
String : nazwa wbudowanej konfiguracji do załadowania lub ścieżka do pliku konfiguracji do załadowania |
isGlobal |
boolean |
templateMap |
|
Zwroty | |
---|---|
ConfigurationDef |
ConfigurationDef |
Rzuty | |
---|---|
ConfigurationException |
jeśli wystąpił błąd podczas wczytywania konfiguracji. |
getMapConfig
protectedgetMapConfig ()
Wyeksponowane do testowania. Zwracanie kopii mapy.
Zwroty | |
---|---|
|
Konfiguracja isDirect
protected boolean isDirectConfiguration (String configName)
Parametry | |
---|---|
configName |
String |
Zwroty | |
---|---|
boolean |
zmień kolejność argumentów
protected String[] reorderArgs (String[] args)
Zmień kolejność argumentów, tak aby argumenty mapy zostały przeniesione na początek.
Parametry | |
---|---|
args |
String |
Zwroty | |
---|---|
String[] |
resolveRemoteFile
protected IRemoteFileResolver.ResolvedFile resolveRemoteFile (URI configURI, URI destDir)
Parametry | |
---|---|
configURI |
URI |
destDir |
URI |
Zwroty | |
---|---|
IRemoteFileResolver.ResolvedFile |
Rzuty | |
---|---|
BuildRetrievalError |