ConfigurationFactory

public class ConfigurationFactory
extends Object implements IConfigurationFactory

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

Известные прямые подклассы GCSConfigurationFactory , RetryConfigurationFactory , SandboxConfigurationFactory GCSConfigurationFactory ConfigurationFactory загружает конфигурации из Google Cloud Storage. RetryConfigurationFactory Фабрика, которая обрабатывает повторную попытку выполнения команды. SandboxConfigurationFactory Специальная фабрика конфигураций для создания настроек в целях изоляции процессов (песочницы).

---

Фабрика для создания IConfiguration .

Краткое содержание

Вложенные классы
class	ConfigurationFactory.ConfigLoader Реализация IConfigDefLoader, которая отслеживает включенные конфигурации из одной корневой конфигурации и генерирует исключение при циклических включениях.
class	ConfigurationFactory.ExceptionLoader

Защищенные конструкторы
ConfigurationFactory ()

Общедоступные методы
void	clearMapConfig () В некоторых конкретных случаях нам необходимо очистить карту.
IConfiguration	createConfigurationFromArgs (String[] arrayArgs, List<String> unconsumedArgs, IKeyStoreClient keyStoreClient) Создайте объект IConfiguration из аргументов командной строки, указав хранилище ключей.
IConfiguration	createConfigurationFromArgs (String[] arrayArgs, List<String> unconsumedArgs) Создайте объект IConfiguration из аргументов командной строки.
IConfiguration	createConfigurationFromArgs (String[] arrayArgs) Вспомогательный метод, который вызывает createConfigurationFromArgs(String[],List) со вторым аргументом, null .
IGlobalConfiguration	createGlobalConfigurationFromArgs (String[] arrayArgs, List<String> remainingArgs) Создайте объект IGlobalConfiguration из аргументов командной строки.
IConfiguration	createPartialConfigurationFromArgs (String[] arrayArgs, IKeyStoreClient keyStoreClient, Set<String> allowedObjects, TradefedDelegator delegator) Создайте конфигурацию, содержащую только выбранный набор объектов.
void	dumpConfig (String configName, PrintStream out) Выводит содержимое конфигурации в указанный PrintStream
List<String>	getConfigList (String subPath, boolean loadFromEnv) Вариант функции getConfigList() , позволяющий указать, хотим ли мы также загрузить конфигурацию из окружения.
List<String>	getConfigList () Возвращает список имен всех конфигурационных файлов, найденных в JAR-файлах, находящихся в classpath.
static IConfigurationFactory	getInstance () Получите экземпляр IConfigurationFactory являющийся синглтоном.
void	loadAllConfigs (boolean discardExceptions) Загружает все конфигурации, найденные в каталогах classpath и test cases.
void	loadAndPrintAllConfigs () Вспомогательный метод, проверяющий возможность загрузки, анализа и установки всех значений параметров для всех конфигурационных файлов.
void	printHelp (PrintStream out) Печать помогает увеличить объём производства на этом заводе.
void	printHelpForConfig (String[] args, boolean importantOnly, PrintStream out) Выводит справочную информацию для параметра IConfiguration , указанного в аргументах командной строки. Если 'args' указывает на известную конфигурацию, будет создан объект IConfiguration из XML-файла, и будет выведена справка по этому IConfiguration .

Защищенные методы
InputStream	getBundledConfigStream (String name)
String	getConfigPrefix () Возвращает префикс пути к XML-файлам конфигурации в classpath. Это позволяет модульным тестам имитировать ошибки.
BufferedInputStream	getConfigStream (String name) Загружает InputStream для заданного имени конфигурации.
ConfigurationDef	getConfigurationDef (String name, boolean isGlobal, Map<String, String> templateMap) Получить ConfigurationDef для заданного имени
Map<ConfigurationFactory.ConfigId, ConfigurationDef >	getMapConfig () Выставлено для тестирования.
boolean	isDirectConfiguration (String configName)
String[]	reorderArgs (String[] args) Измените порядок аргументов таким образом, чтобы все аргументы template:map оказались в начале списка.
IRemoteFileResolver.ResolvedFile	resolveRemoteFile (URI configURI, URI destDir)

Защищенные конструкторы

ConfigurationFactory

protected ConfigurationFactory ()

Общедоступные методы

clearMapConfig

public void clearMapConfig ()

В некоторых конкретных случаях нам необходимо очистить карту.

createConfigurationFromArgs

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

Создайте объект IConfiguration из аргументов командной строки, указав хранилище ключей.

Ожидаемый формат: "CONFIG [параметры]", где CONFIG — это имя встроенной конфигурации или путь к XML-файлу конфигурации.

Параметры
arrayArgs	String : аргументы командной строки
unconsumedArgs	List : список, который будет заполнен аргументами, не обработанными объектами, связанными с указанной конфигурацией. Если он равен null , то реализация выбросит исключение ConfigurationException если останутся какие-либо необработанные аргументы.
keyStoreClient	IKeyStoreClient : объект IKeyStoreClient , используемый для получения конфиденциальной информации из аргументов.

Возвраты
IConfiguration	Загружен IConfiguration . Поля Option объекта делегата заполнены значениями из аргументов.

Броски
ConfigurationException

createConfigurationFromArgs

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

Создайте объект IConfiguration из аргументов командной строки.

Ожидаемый формат: "CONFIG [параметры]", где CONFIG — это имя встроенной конфигурации или путь к XML-файлу конфигурации.

Параметры
arrayArgs	String : аргументы командной строки
unconsumedArgs	List : список, который будет заполнен аргументами, не обработанными объектами, связанными с указанной конфигурацией. Если он равен null , то реализация выбросит исключение ConfigurationException если останутся какие-либо необработанные аргументы.

Возвраты
IConfiguration	Загружен IConfiguration . Поля Option объекта делегата заполнены значениями из аргументов.

Броски
ConfigurationException

createConfigurationFromArgs

public IConfiguration createConfigurationFromArgs (String[] arrayArgs)

Удобный метод, который вызывает createConfigurationFromArgs(String[],List) со вторым аргументом, null . Таким образом, он выбросит ConfigurationException если останутся какие-либо неиспользованные аргументы.

Параметры
arrayArgs	String

Возвраты
IConfiguration

Броски
ConfigurationException

createGlobalConfigurationFromArgs

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

Создайте объект IGlobalConfiguration из аргументов командной строки.

Ожидаемый формат: "CONFIG [параметры]", где CONFIG — это имя встроенной конфигурации или путь к XML-файлу конфигурации.

Параметры
arrayArgs	String : аргументы командной строки
remainingArgs	List : список, который будет заполнен аргументами, не обработанными как глобальные аргументы.

Возвраты
IGlobalConfiguration	Загружен объект IGlobalConfiguration . Поля Option объекта делегата заполнены значениями из аргументов.

Броски
ConfigurationException

createPartialConfigurationFromArgs

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

Создайте конфигурацию, содержащую только выбранный набор объектов.

Параметры
arrayArgs	String : Аргументы командной строки
keyStoreClient	IKeyStoreClient : Объект IKeyStoreClient , используемый для получения конфиденциальной информации из аргументов.
allowedObjects	Set : Набор разрешенных для создания объектов.
delegator	TradefedDelegator

Возвраты
IConfiguration	Загруженная IConfiguration .

Броски
ConfigurationException

dumpConfig

public void dumpConfig (String configName, 
                PrintStream out)

Выводит содержимое конфигурации в указанный PrintStream

Параметры
configName	String : имя конфигурации
out	PrintStream : PrintStream , в который будет выводиться результат.

getConfigList

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

Вариант функции getConfigList() , позволяющий указать, хотим ли мы также загрузить конфигурацию из окружения.

Параметры
subPath	String : имя подкаталогов, в которых следует искать конфигурацию. Если значение равно null, поведение будет аналогично методу getConfigList() .
loadFromEnv	boolean : True, если необходимо загрузить конфигурацию в переменную среды.

Возвраты
List<String>

getConfigList

public List<String> getConfigList ()

Возвращает список имен всех конфигурационных файлов, найденных в JAR-файлах в classpath. Не пытается загрузить ни один из конфигурационных файлов, поэтому в этом списке могут быть неработающие файлы.

Возвраты
List<String>

получить экземпляр

public static IConfigurationFactory getInstance ()

Получите экземпляр IConfigurationFactory являющийся синглтоном.

Возвраты
IConfigurationFactory

loadAllConfigs

public void loadAllConfigs (boolean discardExceptions)

Загружает все конфигурации, найденные в каталогах classpath и test cases.

Параметры
discardExceptions	boolean : true, если какое-либо исключение ConfigurationException следует игнорировать.

Броски
	com.android.tradefed.config.ConfigurationException
ConfigurationException

loadAndPrintAllConfigs

public void loadAndPrintAllConfigs ()

Вспомогательный метод, проверяющий возможность загрузки, анализа и установки всех значений параметров всех конфигурационных файлов. Предоставляется только для того, чтобы зависимые проекты могли проверять свои конфигурации. Не должен отображаться в консоли.

Броски
ConfigurationException	если не удалось загрузить одну или несколько конфигураций

printHelp

public void printHelp (PrintStream out)

Печать помогает увеличить объём производства на этом заводе.

Выводит общую справочную информацию и список всех доступных конфигураций.

Параметры
out	PrintStream : PrintStream , в который будет выводиться результат.

printHelpForConfig

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

Выводит справочную информацию для параметра IConfiguration , указанного в аргументах командной строки.

Если 'args' относится к известной конфигурации, из XML будет создан объект IConfiguration , и будет выведена справка по этому IConfiguration . Обратите внимание, что все остальные значения 'args' будут игнорироваться (т.е. текст справки будет описывать текущие значения Option , загруженные из XML, и не будет отражать значения параметров, установленные аргументами командной строки).

Если параметр 'args' не ссылается на известную IConfiguration , будет отображена стандартная справка printHelp(PrintStream) .

Параметры
args	String : аргументы командной строки
importantOnly	boolean : если true , вывести сокращенную справку, содержащую только важные сведения.
out	PrintStream : PrintStream , в который будет выводиться результат.

Защищенные методы

getBundledConfigStream

protected InputStream getBundledConfigStream (String name)

Параметры
name	String

Возвраты
InputStream

getConfigPrefix

protected String getConfigPrefix ()

Возвращает префикс пути к XML-файлам конфигурации в classpath.

Это позволяет модульным тестам имитировать ошибки.

Возвраты
String	String путь с завершающим символом /

getConfigStream

protected BufferedInputStream getConfigStream (String name)

Загружает InputStream для заданного имени конфигурации.

Параметры
name	String : имя конфигурации для загрузки

Возвраты
BufferedInputStream	BufferedInputStream для чтения содержимого конфигурации.

Броски
ConfigurationException	если конфигурация не найдена

getConfigurationDef

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

Получить ConfigurationDef для заданного имени

Параметры
name	String : имя встроенной конфигурации для загрузки или путь к файлу конфигурации для загрузки.
isGlobal	boolean
templateMap	Map

Возвраты
ConfigurationDef	ConfigurationDef

Броски
ConfigurationException	если при загрузке конфигурации произошла ошибка

getMapConfig

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

Карта доступна для тестирования. Верните копию карты.

Возвраты
Map<ConfigurationFactory.ConfigId, ConfigurationDef >

isDirectConfiguration

protected boolean isDirectConfiguration (String configName)

Параметры
configName	String

Возвраты
boolean

reorderArgs

protected String[] reorderArgs (String[] args)

Измените порядок аргументов таким образом, чтобы все аргументы template:map оказались в начале списка.

Параметры
args	String

Возвраты
String[]

resolveRemoteFile

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

Параметры
configURI	URI
destDir	URI

Возвраты
IRemoteFileResolver.ResolvedFile

Броски
BuildRetrievalError