設定
public
class
Configuration
extends Object
implements
IConfiguration
| java.lang.Object | |
| ↳ | com.android.tradefed.config.Configuration |
具體的 IConfiguration 實作項目,可將載入的設定物件儲存在對應中。
摘要
常數 | |
|---|---|
String |
BUILD_PROVIDER_TYPE_NAME
|
String |
CMD_OPTIONS_TYPE_NAME
|
String |
CONFIGURATION_DESCRIPTION_TYPE_NAME
|
String |
COVERAGE_OPTIONS_TYPE_NAME
|
String |
DEVICE_METRICS_COLLECTOR_TYPE_NAME
|
String |
DEVICE_NAME
|
String |
DEVICE_OPTIONS_TYPE_NAME
|
String |
DEVICE_RECOVERY_TYPE_NAME
|
String |
DEVICE_REQUIREMENTS_TYPE_NAME
|
String |
GLOBAL_FILTERS_TYPE_NAME
|
String |
LAB_PREPARER_TYPE_NAME
|
String |
LOGGER_TYPE_NAME
|
String |
LOG_SAVER_TYPE_NAME
|
String |
METRIC_POST_PROCESSOR_TYPE_NAME
|
String |
MULTI_PREPARER_TYPE_NAME
|
String |
MULTI_PRE_TARGET_PREPARER_TYPE_NAME
|
String |
RESULT_REPORTER_TYPE_NAME
|
String |
RETRY_DECISION_TYPE_NAME
|
String |
SANBOX_OPTIONS_TYPE_NAME
|
String |
SANDBOX_TYPE_NAME
|
String |
SKIP_MANAGER_TYPE_NAME
|
String |
SYSTEM_STATUS_CHECKER_TYPE_NAME
|
String |
TARGET_PREPARER_TYPE_NAME
|
String |
TEST_TYPE_NAME
|
欄位 | |
|---|---|
public
static
final
Set<String> |
NON_MODULE_OBJECTS
|
公用建構函式 | |
|---|---|
Configuration(String name, String description)
使用預設設定物件建立 |
|
受保護的方法 | |
|---|---|
boolean
|
isRemoteEnvironment()
傳回 TF 環境是否為遠端呼叫。 |
常數
BUILD_PROVIDER_TYPE_NAME
public static final String BUILD_PROVIDER_TYPE_NAME
常數值: "build_provider"
CMD_OPTIONS_TYPE_NAME
public static final String CMD_OPTIONS_TYPE_NAME
常數值: "cmd_options"
CONFIGURATION_DESCRIPTION_TYPE_NAME
public static final String CONFIGURATION_DESCRIPTION_TYPE_NAME
常數值: "config_desc"
COVERAGE_OPTIONS_TYPE_NAME
public static final String COVERAGE_OPTIONS_TYPE_NAME
常數值: "coverage"
DEVICE_METRICS_COLLECTOR_TYPE_NAME
public static final String DEVICE_METRICS_COLLECTOR_TYPE_NAME
常數值: "metrics_collector"
DEVICE_NAME
public static final String DEVICE_NAME
常數值: "device"
DEVICE_OPTIONS_TYPE_NAME
public static final String DEVICE_OPTIONS_TYPE_NAME
常數值: "device_options"
DEVICE_RECOVERY_TYPE_NAME
public static final String DEVICE_RECOVERY_TYPE_NAME
常數值: "device_recovery"
DEVICE_REQUIREMENTS_TYPE_NAME
public static final String DEVICE_REQUIREMENTS_TYPE_NAME
常數值: "device_requirements"
GLOBAL_FILTERS_TYPE_NAME
public static final String GLOBAL_FILTERS_TYPE_NAME
常數值: "global_filters"
LAB_PREPARER_TYPE_NAME
public static final String LAB_PREPARER_TYPE_NAME
常數值: "lab_preparer"
LOGGER_TYPE_NAME
public static final String LOGGER_TYPE_NAME
常數值: "logger"
LOG_SAVER_TYPE_NAME
public static final String LOG_SAVER_TYPE_NAME
常數值: "log_saver"
METRIC_POST_PROCESSOR_TYPE_NAME
public static final String METRIC_POST_PROCESSOR_TYPE_NAME
常數值: "metric_post_processor"
MULTI_PREPARER_TYPE_NAME
public static final String MULTI_PREPARER_TYPE_NAME
常數值: "multi_target_preparer"
MULTI_PRE_TARGET_PREPARER_TYPE_NAME
public static final String MULTI_PRE_TARGET_PREPARER_TYPE_NAME
常數值: "multi_pre_target_preparer"
RESULT_REPORTER_TYPE_NAME
public static final String RESULT_REPORTER_TYPE_NAME
常數值: "result_reporter"
RETRY_DECISION_TYPE_NAME
public static final String RETRY_DECISION_TYPE_NAME
常數值: "retry_decision"
SANBOX_OPTIONS_TYPE_NAME
public static final String SANBOX_OPTIONS_TYPE_NAME
常數值: "sandbox_options"
SANDBOX_TYPE_NAME
public static final String SANDBOX_TYPE_NAME
常數值: "sandbox"
SKIP_MANAGER_TYPE_NAME
public static final String SKIP_MANAGER_TYPE_NAME
常數值: "skip_manager"
SYSTEM_STATUS_CHECKER_TYPE_NAME
public static final String SYSTEM_STATUS_CHECKER_TYPE_NAME
常數值: "system_checker"
TARGET_PREPARER_TYPE_NAME
public static final String TARGET_PREPARER_TYPE_NAME
常數值: "target_preparer"
TEST_TYPE_NAME
public static final String TEST_TYPE_NAME
常數值: "test"
欄位
NON_MODULE_OBJECTS
public static final Set<String> NON_MODULE_OBJECTS
公用建構函式
設定
public Configuration (String name,
String description)使用預設設定物件建立 Configuration。
| 參數 | |
|---|---|
name |
String |
description |
String |
公用方法
addFilesToClean
public void addFilesToClean (Set<File> toBeCleaned)
新增在 cleanConfigurationData() 期間必須清除的檔案
| 參數 | |
|---|---|
toBeCleaned |
Set |
cleanConfigurationData
public void cleanConfigurationData ()
刪除下載至遠端檔案「已解決」選項欄位的任何檔案。
dumpXml
public void dumpXml (PrintWriter output)
取得設定的展開 XML 檔案,其中顯示這個 IConfiguration 的所有選項 (做為 String)。
| 參數 | |
|---|---|
output |
PrintWriter:要將 XML 列印至的寫入器。 |
| 擲回 | |
|---|---|
IOException |
|
dumpXml
public void dumpXml (PrintWriter output,
List<String> excludeFilters)取得設定的展開 XML 檔案,其中顯示這個 IConfiguration 的所有選項,但物件會依鍵名篩選。
篩選器範例:Configuration.TARGET_PREPARER_TYPE_NAME。
| 參數 | |
|---|---|
output |
PrintWriter:要將 XML 列印至的寫入器。 |
excludeFilters |
List:不應傾印的物件型別清單。 |
| 擲回 | |
|---|---|
IOException |
|
dumpXml
public void dumpXml (PrintWriter output,
List<String> excludeFilters,
boolean printDeprecatedOptions,
boolean printUnchangedOptions)取得設定的展開 XML 檔案,其中顯示這個 IConfiguration 的所有選項,但物件會依鍵名篩選。
篩選器範例:Configuration.TARGET_PREPARER_TYPE_NAME。
| 參數 | |
|---|---|
output |
PrintWriter:要將 XML 列印至的寫入器。 |
excludeFilters |
List:不應傾印的物件型別清單。 |
printDeprecatedOptions |
boolean:是否要列印標示為已淘汰的選項 |
printUnchangedOptions |
boolean |
| 擲回 | |
|---|---|
IOException |
|
getAllConfigurationObjectsOfType
public Collection<Object> getAllConfigurationObjectsOfType (String configType)
通用介面,可取得所有裝置中指定型別名稱的所有物件。
| 參數 | |
|---|---|
configType |
String:設定物件的專屬類型 |
| 傳回 | |
|---|---|
Collection<Object> |
指定類型的設定物件清單。 |
getBuildProvider
public IBuildProvider getBuildProvider ()
從設定取得 IBuildProvider。
| 傳回 | |
|---|---|
IBuildProvider |
設定中提供的 IBuildProvider |
getCommandLine
public String getCommandLine ()
取得用於建立這個 IConfiguration 的指令列。
| 傳回 | |
|---|---|
String |
用於建立這個 IConfiguration 的指令列。 |
getCommandOptions
public ICommandOptions getCommandOptions ()
從設定取得要使用的 ICommandOptions。
| 傳回 | |
|---|---|
ICommandOptions |
設定中提供的 ICommandOptions。 |
getConfigurationDescription
public ConfigurationDescriptor getConfigurationDescription ()
傳回設定中提供的 ConfigurationDescriptor。
| 傳回 | |
|---|---|
ConfigurationDescriptor |
|
getConfigurationObject
public Object getConfigurationObject (String typeName)
通用介面,可取得具有指定型別名稱的設定物件。
| 參數 | |
|---|---|
typeName |
String:設定物件的專屬類型 |
| 傳回 | |
|---|---|
Object |
設定物件,或如果具有指定名稱的物件類型不存在,則為 null。 |
getConfigurationObjectList
public List<?> getConfigurationObjectList (String typeName)
與 getConfigurationObject(String) 類似,但適用於支援多個物件的設定物件類型。
| 參數 | |
|---|---|
typeName |
String:設定物件的專屬型別名稱 |
| 傳回 | |
|---|---|
List<?> |
設定物件清單,或如果具有指定名稱的物件類型不存在,則為 null。 |
getCoverageOptions
public CoverageOptions getCoverageOptions ()
從設定取得要使用的 CoverageOptions。
| 傳回 | |
|---|---|
CoverageOptions |
設定中提供的 CoverageOptions。 |
getDeviceConfig
public List<IDeviceConfiguration> getDeviceConfig ()
從設定取得 IDeviceConfiguration。
| 傳回 | |
|---|---|
List<IDeviceConfiguration> |
設定中依序提供的 IDeviceConfiguration |
getDeviceConfigByName
public IDeviceConfiguration getDeviceConfigByName (String nameDevice)
傳回與所提供名稱相關聯的 IDeviceConfiguration,如果找不到則傳回 null。
| 參數 | |
|---|---|
nameDevice |
String |
| 傳回 | |
|---|---|
IDeviceConfiguration |
|
getDeviceOptions
public TestDeviceOptions getDeviceOptions ()
從設定取得要使用的 TestDeviceOptions。
| 傳回 | |
|---|---|
TestDeviceOptions |
設定中提供的 TestDeviceOptions。 |
getDeviceRecovery
public IDeviceRecovery getDeviceRecovery ()
從設定取得要使用的 IDeviceRecovery。
| 傳回 | |
|---|---|
IDeviceRecovery |
設定中提供的 IDeviceRecovery。 |
getDeviceRequirements
public IDeviceSelection getDeviceRequirements ()
從設定取得要使用的 IDeviceSelection。
| 傳回 | |
|---|---|
IDeviceSelection |
設定中提供的 IDeviceSelection。 |
getFilesToClean
public Set<File> getFilesToClean ()
取得 cleanConfigurationData() 期間會清除的檔案清單
| 傳回 | |
|---|---|
Set<File> |
|
getGlobalFilters
public GlobalTestFilter getGlobalFilters ()
取得叫用作業的 GlobalTestFilter。
| 傳回 | |
|---|---|
GlobalTestFilter |
|
getInopOptions
public Set<String> getInopOptions ()
取得未變更任何值的選項名稱
| 傳回 | |
|---|---|
Set<String> |
|
getLabPreparers
public List<ITargetPreparer> getLabPreparers ()
從設定取得 ITargetPreparer。
| 傳回 | |
|---|---|
List<ITargetPreparer> |
設定中依序提供的 ITargetPreparer |
getLogOutput
public ILeveledLogOutput getLogOutput ()
從設定取得要使用的 ILeveledLogOutput。
| 傳回 | |
|---|---|
ILeveledLogOutput |
設定中提供的 ILeveledLogOutput。 |
getMetricCollectors
public List<IMetricCollector> getMetricCollectors ()
從設定取得 IMetricCollector。
| 傳回 | |
|---|---|
List<IMetricCollector> |
|
getMultiDeviceSupportedTag
public static Set<String> getMultiDeviceSupportedTag ()
傳回裝置代碼中支援的代碼 Set,用於多裝置設定。
| 傳回 | |
|---|---|
Set<String> |
|
getMultiPreTargetPreparers
public List<IMultiTargetPreparer> getMultiPreTargetPreparers ()
從應在任何裝置 target_preparer 之前執行的設定取得 IMultiTargetPreparer。
| 傳回 | |
|---|---|
List<IMultiTargetPreparer> |
設定中依序提供的 IMultiTargetPreparer |
getMultiTargetPreparers
public List<IMultiTargetPreparer> getMultiTargetPreparers ()
從設定取得 IMultiTargetPreparer。
| 傳回 | |
|---|---|
List<IMultiTargetPreparer> |
設定中依序提供的 IMultiTargetPreparer |
getName
public String getName ()
傳回設定名稱。
| 傳回 | |
|---|---|
String |
|
getPostProcessors
public List<IPostProcessor> getPostProcessors ()
從設定取得 IPostProcessor。
| 傳回 | |
|---|---|
List<IPostProcessor> |
|
getRetryDecision
public IRetryDecision getRetryDecision ()
傳回用於調用的 IRetryDecision。
| 傳回 | |
|---|---|
IRetryDecision |
|
getSystemStatusCheckers
public List<ISystemStatusChecker> getSystemStatusCheckers ()
從設定取得 ISystemStatusChecker。
| 傳回 | |
|---|---|
List<ISystemStatusChecker> |
設定中依序提供的 ISystemStatusChecker |
getTargetPreparers
public List<ITargetPreparer> getTargetPreparers ()
從設定取得 ITargetPreparer。
| 傳回 | |
|---|---|
List<ITargetPreparer> |
設定中依序提供的 ITargetPreparer |
getTestInvocationListeners
public List<ITestInvocationListener> getTestInvocationListeners ()
從設定中取得要使用的 ITestInvocationListener。
| 傳回 | |
|---|---|
List<ITestInvocationListener> |
設定中提供的 ITestInvocationListener。 |
injectOptionValue
public void injectOptionValue (String optionName,
String optionValue)將選項值插入設定物件集。
有助於為動態產生的選項提供值。
| 參數 | |
|---|---|
optionName |
String:選項名稱 |
optionValue |
String:選項值 |
| 擲回 | |
|---|---|
ConfigurationException |
|
injectOptionValue
public void injectOptionValue (String optionName,
String optionKey,
String optionValue)將選項值插入設定物件集。
有助於為動態產生的選項提供值。
| 參數 | |
|---|---|
optionName |
String:選項名稱 |
optionKey |
String:地圖選項的選用鍵,或空值 |
optionValue |
String:地圖選項值 |
| 擲回 | |
|---|---|
ConfigurationException |
|
injectOptionValueWithSource
public void injectOptionValueWithSource (String optionName,
String optionKey,
String optionValue,
String source)將選項值插入設定物件集。
有助於為動態產生的選項提供值。
| 參數 | |
|---|---|
optionName |
String:選項名稱 |
optionKey |
String:地圖選項的選用鍵,或空值 |
optionValue |
String:地圖選項值 |
source |
String:提供這個選項值的來源設定 |
| 擲回 | |
|---|---|
ConfigurationException |
|
injectOptionValues
public void injectOptionValues (List<OptionDef> optionDefs)
將多個選項值插入設定物件集。
建立新物件後,一次注入多個選項值時非常實用。
| 參數 | |
|---|---|
optionDefs |
List:要插入的選項定義清單 |
| 擲回 | |
|---|---|
ConfigurationException |
|
isDeviceConfiguredFake
public boolean isDeviceConfiguredFake (String deviceName)
傳回已設定的裝置是否標記為 isFake=true。
| 參數 | |
|---|---|
deviceName |
String |
| 傳回 | |
|---|---|
boolean |
|
partialDeepClone
public IConfiguration partialDeepClone (List<String> objectToDeepClone, IKeyStoreClient client)
從 clone() 建立基本複製項目,然後深層複製指定設定物件的清單。
| 參數 | |
|---|---|
objectToDeepClone |
List:要深層複製的設定物件清單。 |
client |
IKeyStoreClient:金鑰儲存區用戶端。 |
| 傳回 | |
|---|---|
IConfiguration |
部分深層複製的設定。 |
| 擲回 | |
|---|---|
ConfigurationException |
|
printCommandUsage
public void printCommandUsage (boolean importantOnly,
PrintStream out)將此設定的指令列用法說明文字輸出至指定的 printStream。
| 參數 | |
|---|---|
importantOnly |
boolean:如果 true 只列印重要選項的說明 |
out |
PrintStream:要使用的 PrintStream。 |
| 擲回 | |
|---|---|
|
com.android.tradefed.config.ConfigurationException |
ConfigurationException |
|
resolveDynamicOptions
public void resolveDynamicOptions (DynamicRemoteFileResolver resolver)
解決指向遠端位置的 File 選項。這需要呼叫 cleanConfigurationData() 來清理檔案。
| 參數 | |
|---|---|
resolver |
DynamicRemoteFileResolver:DynamicRemoteFileResolver,用於解析檔案 |
| 擲回 | |
|---|---|
BuildRetrievalError |
|
ConfigurationException |
|
safeInjectOptionValues
public void safeInjectOptionValues (List<OptionDef> optionDefs)
將多個選項值插入設定物件集,即使其中一個選項無法套用,也不會擲回例外狀況。
建立新物件後,一次注入多個選項值時非常實用。
| 參數 | |
|---|---|
optionDefs |
List:要插入的選項定義清單 |
| 擲回 | |
|---|---|
ConfigurationException |
|
setBestEffortOptionsFromCommandLineArgs
public List<String> setBestEffortOptionsFromCommandLineArgs (List<String> listArgs,
IKeyStoreClient keyStoreClient)盡可能使用一組指定的指令列引數,設定 config Option 欄位。
請參閱 ArgsOptionParser,瞭解預期格式。
| 參數 | |
|---|---|
listArgs |
List:指令列引數 |
keyStoreClient |
IKeyStoreClient:要使用的 IKeyStoreClient。 |
| 傳回 | |
|---|---|
List<String> |
未使用的引數 |
| 擲回 | |
|---|---|
ConfigurationException |
|
setBuildProvider
public void setBuildProvider (IBuildProvider provider)
取代設定中的現有 IBuildProvider。
| 參數 | |
|---|---|
provider |
IBuildProvider:新的 IBuildProvider |
setCommandLine
public void setCommandLine (String[] arrayArgs)
設定用於建立這個 IConfiguration 的指令列。
這會儲存整個指令列,包括設定名稱,與 setOptionsFromCommandLineArgs 不同。
| 參數 | |
|---|---|
arrayArgs |
String:指令列 |
setCommandOptions
public void setCommandOptions (ICommandOptions cmdOptions)
設定 ICommandOptions,取代所有現有值
setConfigurationObject
public void setConfigurationObject (String typeName,
Object configObject)設定具有指定名稱的設定物件,並取代任何現有值的通用方法。
| 參數 | |
|---|---|
typeName |
String:設定物件型別的專屬名稱。 |
configObject |
Object:設定物件 |
| 擲回 | |
|---|---|
ConfigurationException |
|
setConfigurationObjectList
public void setConfigurationObjectList (String typeName,
List<?> configList)一般方法:為指定名稱設定設定物件清單,取代任何現有值。
| 參數 | |
|---|---|
typeName |
String:設定物件型別的專屬名稱。 |
configList |
List:設定物件清單 |
| 擲回 | |
|---|---|
ConfigurationException |
|
setCoverageOptions
public void setCoverageOptions (CoverageOptions coverageOptions)
設定 CoverageOptions,取代所有現有值。
| 參數 | |
|---|---|
coverageOptions |
CoverageOptions |
setDeviceConfig
public void setDeviceConfig (IDeviceConfiguration deviceConfig)
設定 IDeviceConfiguration,取代所有現有值。
setDeviceConfigList
public void setDeviceConfigList (List<IDeviceConfiguration> deviceConfigs)
設定 IDeviceConfiguration,取代現有值。
setDeviceMetricCollectors
public void setDeviceMetricCollectors (List<IMetricCollector> collectors)
設定 IMetricCollector 清單,取代所有現有值。
| 參數 | |
|---|---|
collectors |
List |
setDeviceOptions
public void setDeviceOptions (TestDeviceOptions devOptions)
設定 TestDeviceOptions,取代所有現有值
| 參數 | |
|---|---|
devOptions |
TestDeviceOptions |
setDeviceRecovery
public void setDeviceRecovery (IDeviceRecovery recovery)
設定 IDeviceRecovery,取代所有現有值。
setDeviceRequirements
public void setDeviceRequirements (IDeviceSelection devRequirements)
設定 IDeviceSelection,取代所有現有值
setLabPreparers
public void setLabPreparers (List<ITargetPreparer> preparers)
設定 ITargetPreparer 清單,取代所有現有值。
setMultiPreTargetPreparer
public void setMultiPreTargetPreparer (IMultiTargetPreparer multiPreTargPrep)
便利方法,可在這個設定中設定單一 IMultiTargetPreparer,該設定應在任何裝置 target_preparer 之前執行,並取代任何現有值
setMultiPreTargetPreparers
public void setMultiPreTargetPreparers (List<IMultiTargetPreparer> multiPreTargPreps)
在此設定中,設定應在任何裝置 target_preparers 之前執行的 IMultiTargetPreparer 清單,並取代任何現有值
setMultiTargetPreparer
public void setMultiTargetPreparer (IMultiTargetPreparer multiTargPrep)
設定此設定中單一 IMultiTargetPreparer 的便利方法,會取代任何現有值
setMultiTargetPreparers
public void setMultiTargetPreparers (List<IMultiTargetPreparer> multiTargPreps)
在這項設定中設定 IMultiTargetPreparer 清單,取代所有現有值
setOptionsFromCommandLineArgs
public List<String> setOptionsFromCommandLineArgs (List<String> listArgs)
使用指定的一組指令列引數設定 config Option 欄位
ArgsOptionParser,瞭解預期格式
| 參數 | |
|---|---|
listArgs |
List:指令列引數 |
| 傳回 | |
|---|---|
List<String> |
未使用的引數 |
| 擲回 | |
|---|---|
ConfigurationException |
|
setOptionsFromCommandLineArgs
public List<String> setOptionsFromCommandLineArgs (List<String> listArgs,
IKeyStoreClient keyStoreClient)使用指定的一組指令列引數設定 config Option 欄位
請參閱 ArgsOptionParser,瞭解預期格式。
| 參數 | |
|---|---|
listArgs |
List:指令列引數 |
keyStoreClient |
IKeyStoreClient:要使用的 IKeyStoreClient。 |
| 傳回 | |
|---|---|
List<String> |
未使用的引數 |
| 擲回 | |
|---|---|
ConfigurationException |
|
setPostProcessors
public void setPostProcessors (List<IPostProcessor> processors)
設定 IPostProcessor 清單,取代所有現有值。
| 參數 | |
|---|---|
processors |
List |
setRetryDecision
public void setRetryDecision (IRetryDecision decisionRetry)
設定 IRetryDecision,取代所有現有值。
setSkipManager
public void setSkipManager (SkipManager skipManager)
設定呼叫的 SkipManager。
| 參數 | |
|---|---|
skipManager |
SkipManager |
setSystemStatusChecker
public void setSystemStatusChecker (ISystemStatusChecker systemChecker)
設定此設定中單一 ISystemStatusChecker 的便利方法,會取代任何現有值
setSystemStatusCheckers
public void setSystemStatusCheckers (List<ISystemStatusChecker> systemCheckers)
在這項設定中設定 ISystemStatusChecker 清單,取代所有現有值
setTargetPreparer
public void setTargetPreparer (ITargetPreparer preparer)
設定 ITargetPreparer,取代所有現有值。
setTargetPreparers
public void setTargetPreparers (List<ITargetPreparer> preparers)
設定 ITargetPreparer 清單,取代所有現有值。
setTestInvocationListener
public void setTestInvocationListener (ITestInvocationListener listener)
設定單一 ITestInvocationListener 的便利方法
setTestInvocationListeners
public void setTestInvocationListeners (List<ITestInvocationListener> listeners)
設定 ITestInvocationListener 清單,取代所有現有值
validateOptions
public void validateOptions ()
驗證選項值。
目前這項功能只會驗證是否已設定所有必填選項
| 擲回 | |
|---|---|
ConfigurationException |
|
受保護的方法
isRemoteEnvironment
protected boolean isRemoteEnvironment ()
傳回 TF 環境是否為遠端呼叫。
| 傳回 | |
|---|---|
boolean |
|