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óry śledzi uwzględnione konfiguracje z jednego pliku konfiguracji głównej i wyrzuca wyjątek w przypadku pętli uwzględnień. |
class |
ConfigurationFactory.ExceptionLoader
|
Chronione konstruktory | |
---|---|
ConfigurationFactory()
|
Metody publiczne | |
---|---|
void
|
clearMapConfig()
W niektórych szczególnych przypadkach musimy wyczyścić mapę. |
IConfiguration
|
createConfigurationFromArgs(String[] arrayArgs,
Utwórz |
IConfiguration
|
createConfigurationFromArgs(String[] arrayArgs,
Utwórz |
IConfiguration
|
createConfigurationFromArgs(String[] arrayArgs)
Metoda ułatwiająca, która wywołuje |
IGlobalConfiguration
|
createGlobalConfigurationFromArgs(String[] arrayArgs,
Utwórz |
IConfiguration
|
createPartialConfigurationFromArgs(String[] arrayArgs, IKeyStoreClient keyStoreClient,
Utwórz konfigurację zawierającą tylko wybrane obiekty. |
void
|
dumpConfig(String configName, PrintStream out)
Wyświetla zawartość konfiguracji w danym pliku |
|
getConfigList(String subPath, boolean loadFromEnv)
Wariant |
|
getConfigList()
Zwraca listę nazw wszystkich konfiguracji znalezionych w plikach JAR na ścieżce klas. |
static
IConfigurationFactory
|
getInstance()
Pobierz instancję klasy typu singleton |
void
|
loadAllConfigs(boolean discardExceptions)
Ładuje wszystkie konfiguracje znalezione w katalogach classpath i test cases. |
void
|
loadAndPrintAllConfigs()
Metoda pomocnicza, która sprawdza, czy można wczytać i analizować wszystkie konfiguracje oraz czy są ustawione 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, 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()
Wyeksponowane do testowania. |
boolean
|
isDirectConfiguration(String configName)
|
String[]
|
reorderArgs(String[] args)
Zmień kolejność argumentów, tak aby argumenty mapy zostały przeniesione na początek. |
IRemoteFileResolver.ResolvedFile
|
resolveRemoteFile(URI configURI, URI destDir)
|
Chronione konstruktory
ConfigurationFactory
protected ConfigurationFactory ()
Metody publiczne
clearMapConfig
public void clearMapConfig ()
W niektórych szczególnych przypadkach musimy wyczyścić mapę.
createConfigurationFromArgs
public IConfiguration createConfigurationFromArgs (String[] arrayArgs,unconsumedArgs)
Utwórz IConfiguration
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ń |
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. |
Zwroty | |
---|---|
IConfiguration |
wczytany 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 XML konfiguracji.
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 |
wczytany IConfiguration . Pola obiektu delegowana Option zostały wypełnione wartościami z argów. |
Rzuty | |
---|---|
ConfigurationException |
createConfigurationFromArgs
public IConfiguration createConfigurationFromArgs (String[] arrayArgs)
Metoda ułatwiająca, która wywołuje ERROR(/#createConfigurationFromArgs(String[],List))
z drugim argumentem null
. W związku z tym ConfigurationException
zostanie wyrzucone, jeśli pozostaną 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 |
wczytany IGlobalConfiguration . Pola obiektu delegowana Option zostały wypełnione wartościami z argów. |
Rzuty | |
---|---|
ConfigurationException |
createPartialConfigurationFromArgs
public IConfiguration createPartialConfigurationFromArgs (String[] arrayArgs, IKeyStoreClient keyStoreClient,allowedObjects, TradefedDelegator delegator)
Utwórz konfigurację zawierającą tylko wybrane obiekty.
Parametry | |
---|---|
arrayArgs |
String : argumenty wiersza poleceń |
keyStoreClient |
IKeyStoreClient : IKeyStoreClient , który służy do uzyskiwania informacji poufnych w argumencie args. |
allowedObjects |
: zbiór dozwolonych obiektów do utworzenia. |
delegator |
TradefedDelegator |
Zwroty | |
---|---|
IConfiguration |
Wczytany IConfiguration . |
Rzuty | |
---|---|
ConfigurationException |
dumpConfig
public void dumpConfig (String configName, PrintStream out)
Wyświetla zawartość konfiguracji w danym pliku ERROR(/PrintStream)
.
Parametry | |
---|---|
configName |
String : nazwa konfiguracji |
out |
PrintStream : ERROR(/PrintStream) , do którego mają być zapisywane 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 jest ustawiony na wartość null, będzie działać tak samo jak parametr getConfigList() . |
loadFromEnv |
boolean : wartość PRAWDA, jeśli konfigurację należy załadować ze zmiennej środowiskowej. |
Zwroty | |
---|---|
|
getConfigList
publicgetConfigList ()
Zwraca listę nazw wszystkich konfiguracji znalezionych w plikach JAR na ścieżce klas. Nie próbuje wczytać żadnej konfiguracji, więc na liście może się znaleźć niedziałająca konfiguracja.
Zwroty | |
---|---|
|
getInstance
public static IConfigurationFactory getInstance ()
Pobierz instancję klasy typu singleton IConfigurationFactory
.
Zwroty | |
---|---|
IConfigurationFactory |
loadAllConfigs
public void loadAllConfigs (boolean discardExceptions)
Ładuje wszystkie konfiguracje znalezione w katalogach classpath i test cases.
Parametry | |
---|---|
discardExceptions |
boolean : wartość true, jeśli należy zignorować wszystkie wyjątki typu ConfigurationException. |
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. Wyświetlane tylko po to, aby zależny projekt mógł zweryfikować konfigurację. Nie powinno być widoczne w konsoli.
Rzuty | |
---|---|
ConfigurationException |
jeśli nie udało się załadować co najmniej 1 konfiguracji |
printHelp
public void printHelp (PrintStream out)
Wypisuje informacje pomocy dla tej fabryki.
Wypisuje ogólne informacje pomocy i wypisuje listę wszystkich dostępnych konfiguracji.
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 dane pomocy dotyczące IConfiguration
określonego w argumentach wiersza poleceń.
Jeśli argument „args” odwołuje się do znanej konfiguracji, zostanie utworzony obiekt IConfiguration
na podstawie pliku XML i wyświetlona pomoc dotycząca tego obiektu.IConfiguration
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 |
Chronione metody
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 |
String ścieżka z końcowym / |
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 |
if config could not be found |
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. zwrócić kopię mapy;
Zwroty | |
---|---|
|
isDirectConfiguration
protected boolean isDirectConfiguration (String configName)
Parametry | |
---|---|
configName |
String |
Zwroty | |
---|---|
boolean |
reorderArgs
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 |