設定
public
class
Configuration
extends Object
implements
IConfiguration
java.lang.Object | |
↳ | com.android.tradefed.config.Configuration |
具體的 IConfiguration
實作,可將已載入的設定物件儲存在地圖中。
摘要
欄位 | |
---|---|
public
static
final
String |
BUILD_PROVIDER_TYPE_NAME
|
public
static
final
String |
CMD_OPTIONS_TYPE_NAME
|
public
static
final
String |
CONFIGURATION_DESCRIPTION_TYPE_NAME
|
public
static
final
String |
COVERAGE_OPTIONS_TYPE_NAME
|
public
static
final
String |
DEVICE_METRICS_COLLECTOR_TYPE_NAME
|
public
static
final
String |
DEVICE_NAME
|
public
static
final
String |
DEVICE_OPTIONS_TYPE_NAME
|
public
static
final
String |
DEVICE_RECOVERY_TYPE_NAME
|
public
static
final
String |
DEVICE_REQUIREMENTS_TYPE_NAME
|
public
static
final
String |
GLOBAL_FILTERS_TYPE_NAME
|
public
static
final
String |
LAB_PREPARER_TYPE_NAME
|
public
static
final
String |
LOGGER_TYPE_NAME
|
public
static
final
String |
LOG_SAVER_TYPE_NAME
|
public
static
final
String |
METRIC_POST_PROCESSOR_TYPE_NAME
|
public
static
final
String |
MULTI_PREPARER_TYPE_NAME
|
public
static
final
String |
MULTI_PRE_TARGET_PREPARER_TYPE_NAME
|
public
static
final
|
NON_MODULE_OBJECTS
|
public
static
final
String |
RESULT_REPORTER_TYPE_NAME
|
public
static
final
String |
RETRY_DECISION_TYPE_NAME
|
public
static
final
String |
SANBOX_OPTIONS_TYPE_NAME
|
public
static
final
String |
SANDBOX_TYPE_NAME
|
public
static
final
String |
SKIP_MANAGER_TYPE_NAME
|
public
static
final
String |
SYSTEM_STATUS_CHECKER_TYPE_NAME
|
public
static
final
String |
TARGET_PREPARER_TYPE_NAME
|
public
static
final
String |
TEST_TYPE_NAME
|
公用建構函式 | |
---|---|
Configuration(String name, String description)
使用預設設定物件建立 |
受保護的方法 | |
---|---|
boolean
|
isRemoteEnvironment()
傳回 TF 的環境是否為遠端叫用。 |
欄位
BUILD_PROVIDER_TYPE_NAME
public static final String BUILD_PROVIDER_TYPE_NAME
CMD_OPTIONS_TYPE_NAME
public static final String CMD_OPTIONS_TYPE_NAME
CONFIGURATION_DESCRIPTION_TYPE_NAME
public static final String CONFIGURATION_DESCRIPTION_TYPE_NAME
COVERAGE_OPTIONS_TYPE_NAME
public static final String COVERAGE_OPTIONS_TYPE_NAME
DEVICE_METRICS_COLLECTOR_TYPE_NAME
public static final String DEVICE_METRICS_COLLECTOR_TYPE_NAME
DEVICE_NAME
public static final String DEVICE_NAME
DEVICE_OPTIONS_TYPE_NAME
public static final String DEVICE_OPTIONS_TYPE_NAME
DEVICE_RECOVERY_TYPE_NAME
public static final String DEVICE_RECOVERY_TYPE_NAME
DEVICE_REQUIREMENTS_TYPE_NAME
public static final String DEVICE_REQUIREMENTS_TYPE_NAME
GLOBAL_FILTERS_TYPE_NAME
public static final String GLOBAL_FILTERS_TYPE_NAME
LAB_PREPARER_TYPE_NAME
public static final String LAB_PREPARER_TYPE_NAME
LOGGER_TYPE_NAME
public static final String LOGGER_TYPE_NAME
LOG_SAVER_TYPE_NAME
public static final String LOG_SAVER_TYPE_NAME
METRIC_POST_PROCESSOR_TYPE_NAME
public static final String METRIC_POST_PROCESSOR_TYPE_NAME
MULTI_PREPARER_TYPE_NAME
public static final String MULTI_PREPARER_TYPE_NAME
MULTI_PRE_TARGET_PREPARER_TYPE_NAME
public static final String MULTI_PRE_TARGET_PREPARER_TYPE_NAME
NON_MODULE_OBJECTS
public static finalNON_MODULE_OBJECTS
RESULT_REPORTER_TYPE_NAME
public static final String RESULT_REPORTER_TYPE_NAME
RETRY_DECISION_TYPE_NAME
public static final String RETRY_DECISION_TYPE_NAME
SANBOX_OPTIONS_TYPE_NAME
public static final String SANBOX_OPTIONS_TYPE_NAME
SANDBOX_TYPE_NAME
public static final String SANDBOX_TYPE_NAME
SKIP_MANAGER_TYPE_NAME
public static final String SKIP_MANAGER_TYPE_NAME
SYSTEM_STATUS_CHECKER_TYPE_NAME
public static final String SYSTEM_STATUS_CHECKER_TYPE_NAME
TARGET_PREPARER_TYPE_NAME
public static final String TARGET_PREPARER_TYPE_NAME
TEST_TYPE_NAME
public static final String TEST_TYPE_NAME
公用建構函式
設定
public Configuration (String name, String description)
使用預設設定物件建立 Configuration
。
參數 | |
---|---|
name |
String |
description |
String |
公用方法
addFilesToClean
public void addFilesToClean (toBeCleaned)
新增cleanConfigurationData()
期間必須清理的檔案
參數 | |
---|---|
toBeCleaned |
|
cleanConfigurationData
public void cleanConfigurationData ()
刪除已下載至已解決的遠端檔案選項欄位的任何檔案。
dumpXml
public void dumpXml (PrintWriter output)
取得設定的展開 XML 檔案,其中顯示此 IConfiguration
的所有選項,並以 String
顯示。
參數 | |
---|---|
output |
PrintWriter :要將 XML 輸出至哪個 Writer。 |
dumpXml
public void dumpXml (PrintWriter output,excludeFilters)
取得設定的展開 XML 檔案,其中包含此 IConfiguration
的所有選項,但不含物件篩選器 (依鍵名篩選)。
篩選器範例:Configuration#TARGET_PREPARER_TYPE_NAME
。
參數 | |
---|---|
output |
PrintWriter :要將 XML 輸出至哪個 Writer。 |
excludeFilters |
:不應轉儲的物件類型清單。 |
dumpXml
public void dumpXml (PrintWriter output,excludeFilters, boolean printDeprecatedOptions, boolean printUnchangedOptions)
取得設定的展開 XML 檔案,其中包含此 IConfiguration
的所有選項,但不含依鍵名稱篩選的物件。
篩選器範例:Configuration#TARGET_PREPARER_TYPE_NAME
。
參數 | |
---|---|
output |
PrintWriter :要將 XML 輸出至哪個 Writer。 |
excludeFilters |
:不應轉儲的物件類型清單。 |
printDeprecatedOptions |
boolean :是否列印標示為已淘汰的選項 |
printUnchangedOptions |
boolean |
getAllConfigurationObjectsOfType
publicgetAllConfigurationObjectsOfType (String configType)
通用介面,可在各裝置上取得特定型別名稱的所有物件。
參數 | |
---|---|
configType |
String :設定物件的專屬類型 |
傳回 | |
---|---|
|
指定類型的設定物件清單。 |
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
publicgetConfigurationObjectList (String typeName)
與 getConfigurationObject(String)
類似,但適用於支援多個物件的設定物件類型。
參數 | |
---|---|
typeName |
String :設定物件專屬的類型名稱 |
傳回 | |
---|---|
|
設定物件清單,如果沒有指定名稱的物件類型,則為 null 。 |
getCoverageOptions
public CoverageOptions getCoverageOptions ()
從設定取得要使用的 CoverageOptions
。
傳回 | |
---|---|
CoverageOptions |
在設定中提供的 CoverageOptions 。 |
getDeviceConfig
publicgetDeviceConfig ()
從設定取得 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 。 |
getGlobalFilters
public GlobalTestFilter getGlobalFilters ()
取得叫用作業的 GlobalTestFilter
。
傳回 | |
---|---|
GlobalTestFilter |
getInopOptions
publicgetInopOptions ()
取得未變更任何值的選項名稱
傳回 | |
---|---|
|
getLogOutput
public ILeveledLogOutput getLogOutput ()
從設定中取得要使用的 ILeveledLogOutput
。
傳回 | |
---|---|
ILeveledLogOutput |
設定中提供的 ILeveledLogOutput 。 |
getMultiDeviceSupportedTag
public staticgetMultiDeviceSupportedTag ()
傳回在多裝置設定裝置標記中支援的標記 ERROR(/Set)
。
傳回 | |
---|---|
|
getMultiPreTargetPreparers
publicgetMultiPreTargetPreparers ()
從設定中取得 IMultiTargetPreparer
,這些 IMultiTargetPreparer
應在任何裝置 target_preparer 之前執行。
傳回 | |
---|---|
|
在設定中依序提供的 IMultiTargetPreparer |
getMultiTargetPreparers
publicgetMultiTargetPreparers ()
從設定中取得 IMultiTargetPreparer
。
傳回 | |
---|---|
|
在設定中依序提供的 IMultiTargetPreparer |
getName
public String getName ()
傳回設定名稱。
傳回 | |
---|---|
String |
getRetryDecision
public IRetryDecision getRetryDecision ()
傳回用於叫用的 IRetryDecision
。
傳回 | |
---|---|
IRetryDecision |
getSystemStatusCheckers
publicgetSystemStatusCheckers ()
從設定中取得 ISystemStatusChecker
。
傳回 | |
---|---|
|
在設定中依序提供的 ISystemStatusChecker |
getTestInvocationListeners
publicgetTestInvocationListeners ()
從設定中取得要使用的 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 (optionDefs)
將多個選項值插入設定物件集合。
在建立新物件後,此方法可用於一次注入多個選項值。
參數 | |
---|---|
optionDefs |
:要插入的選項定義清單 |
擲回 | |
---|---|
ConfigurationException |
isDeviceConfiguredFake
public boolean isDeviceConfiguredFake (String deviceName)
傳回已設定裝置是否標記為 isFake=true。
參數 | |
---|---|
deviceName |
String |
傳回 | |
---|---|
boolean |
partialDeepClone
public IConfiguration partialDeepClone (objectToDeepClone, IKeyStoreClient client)
從 clone()
建立基本克隆,然後深層克隆指定設定物件的清單。
參數 | |
---|---|
objectToDeepClone |
:要進行深層複製的設定物件清單。 |
client |
IKeyStoreClient :KeyStore 用戶端。 |
傳回 | |
---|---|
IConfiguration |
部分深層複製的設定。 |
擲回 | |
---|---|
ConfigurationException |
printCommandUsage
public void printCommandUsage (boolean importantOnly, PrintStream out)
將此設定的指令列使用說明文字輸出至指定的 printStream。
參數 | |
---|---|
importantOnly |
boolean :如果 true 只列印重要選項的說明 |
out |
PrintStream :要使用的 ERROR(/PrintStream) 。 |
擲回 | |
---|---|
|
com.android.tradefed.config.ConfigurationException |
ConfigurationException |
resolveDynamicOptions
public void resolveDynamicOptions (DynamicRemoteFileResolver resolver)
解決指向遠端位置的 ERROR(/File)
選項。這需要呼叫 cleanConfigurationData()
來清理檔案。
參數 | |
---|---|
resolver |
DynamicRemoteFileResolver :用於解析檔案的 DynamicRemoteFileResolver |
擲回 | |
---|---|
BuildRetrievalError |
|
ConfigurationException |
safeInjectOptionValues
public void safeInjectOptionValues (optionDefs)
將多個選項值插入設定物件集,如果無法套用其中一個選項,則不會擲回。
在建立新物件後,此方法可用於一次注入多個選項值。
參數 | |
---|---|
optionDefs |
:要插入的選項定義清單 |
擲回 | |
---|---|
ConfigurationException |
setBestEffortOptionsFromCommandLineArgs
publicsetBestEffortOptionsFromCommandLineArgs ( listArgs, IKeyStoreClient keyStoreClient)
使用最佳努力法,以指定的指令列引數集合設定設定 Option
欄位。
請參閱 ArgsOptionParser
,瞭解預期格式
參數 | |
---|---|
listArgs |
:指令列引數 |
keyStoreClient |
IKeyStoreClient :要使用的 IKeyStoreClient 。 |
傳回 | |
---|---|
|
未使用的引數 |
擲回 | |
---|---|
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,configList)
通用方法,可為指定名稱設定設定物件清單,取代任何現有值。
參數 | |
---|---|
typeName |
String :設定物件類型的專屬名稱。 |
configList |
:設定物件清單 |
擲回 | |
---|---|
ConfigurationException |
setCoverageOptions
public void setCoverageOptions (CoverageOptions coverageOptions)
設定 CoverageOptions
,取代任何現有的值。
參數 | |
---|---|
coverageOptions |
CoverageOptions |
setDeviceConfig
public void setDeviceConfig (IDeviceConfiguration deviceConfig)
設定 IDeviceConfiguration
,取代任何現有值。
setDeviceConfigList
public void setDeviceConfigList (deviceConfigs)
設定 IDeviceConfiguration
,取代任何現有值。
setDeviceMetricCollectors
public void setDeviceMetricCollectors (collectors)
設定 IMetricCollector
清單,取代任何現有值。
參數 | |
---|---|
collectors |
|
setDeviceOptions
public void setDeviceOptions (TestDeviceOptions devOptions)
設定 TestDeviceOptions
,取代任何現有的值
參數 | |
---|---|
devOptions |
TestDeviceOptions |
setDeviceRecovery
public void setDeviceRecovery (IDeviceRecovery recovery)
設定 IDeviceRecovery
,取代任何現有值。
setDeviceRequirements
public void setDeviceRequirements (IDeviceSelection devRequirements)
設定 IDeviceSelection
,取代任何現有值
setMultiPreTargetPreparer
public void setMultiPreTargetPreparer (IMultiTargetPreparer multiPreTargPrep)
針對這項設定設定單一 IMultiTargetPreparer
的便利方法,該設定應在任何裝置 target_preparers 之前執行,取代任何現有值
setMultiPreTargetPreparers
public void setMultiPreTargetPreparers (multiPreTargPreps)
在這個設定中設定 IMultiTargetPreparer
清單,應在任何裝置 target_preparer 之前執行,取代任何現有值
setMultiTargetPreparer
public void setMultiTargetPreparer (IMultiTargetPreparer multiTargPrep)
在這個設定中設定單一 IMultiTargetPreparer
的便利方法,取代任何現有值
setMultiTargetPreparers
public void setMultiTargetPreparers (multiTargPreps)
在這個設定中設定 IMultiTargetPreparer
清單,取代任何現有值
setOptionsFromCommandLineArgs
publicsetOptionsFromCommandLineArgs ( listArgs)
使用指定的指令列引數集合設定設定 Option
欄位
ArgsOptionParser
為預期格式
參數 | |
---|---|
listArgs |
:指令列引數 |
傳回 | |
---|---|
|
未使用的引數 |
擲回 | |
---|---|
ConfigurationException |
setOptionsFromCommandLineArgs
publicsetOptionsFromCommandLineArgs ( listArgs, IKeyStoreClient keyStoreClient)
使用指定的指令列引數集合設定設定 Option
欄位
請參閱 ArgsOptionParser
,瞭解預期格式
參數 | |
---|---|
listArgs |
:指令列引數 |
keyStoreClient |
IKeyStoreClient :要使用的 IKeyStoreClient 。 |
傳回 | |
---|---|
|
未使用的引數 |
擲回 | |
---|---|
ConfigurationException |
setPostProcessors
public void setPostProcessors (processors)
設定 IPostProcessor
清單,取代任何現有值。
參數 | |
---|---|
processors |
|
setRetryDecision
public void setRetryDecision (IRetryDecision decisionRetry)
設定 IRetryDecision
,取代任何現有的值。
setSystemStatusChecker
public void setSystemStatusChecker (ISystemStatusChecker systemChecker)
在這個設定中設定單一 ISystemStatusChecker
的方便方法,取代任何現有值
setSystemStatusCheckers
public void setSystemStatusCheckers (systemCheckers)
在這個設定中設定 ISystemStatusChecker
清單,取代任何現有值
setTargetPreparer
public void setTargetPreparer (ITargetPreparer preparer)
設定 ITargetPreparer
,取代任何現有值。
setTestInvocationListener
public void setTestInvocationListener (ITestInvocationListener listener)
用於設定單一 ITestInvocationListener
的便利方法
setTestInvocationListeners
public void setTestInvocationListeners (listeners)
設定 ITestInvocationListener
清單,取代任何現有值
validateOptions
public void validateOptions ()
驗證選項值。
目前這項驗證只會確認所有必填選項都已設定
擲回 | |
---|---|
ConfigurationException |
受保護的方法
isRemoteEnvironment
protected boolean isRemoteEnvironment ()
傳回 TF 的環境是否為遠端叫用。
傳回 | |
---|---|
boolean |