本頁面由 Cloud Translation API 翻譯而成。

BasePostProcessor

public abstract class BasePostProcessor
extends Object implements IPostProcessor

java.lang.Object
↳	com.android.tradefed.postprocessor.BasePostProcessor

已知的直接子類別

AggregatePostProcessor、AveragePostProcessor、BluetoothConnectionSuccessRatePostProcessor、MetricFilePostProcessor、PerfettoGenericPostProcessor、StatsdGenericPostProcessor

AggregatePostProcessor	指標匯總工具，可針對在多次迭代測試執行期間收集到的數值指標，提供最小值、最大值、平均值、變異數、標準差、總數、計數，以及選用的百分位數，並將這些指標視為雙精度浮點值。
AveragePostProcessor	實作後置處理器，計算指標清單的平均值。
BluetoothConnectionSuccessRatePostProcessor	實作後置處理器，計算藍牙設定檔的成功率使用「metric-key-match」指定包含藍牙連線狀態的指標，並以數值陣列表示，例如 [0, 1, 2, 3, 0, 1, 2, 3]。
MetricFilePostProcessor	用於上傳在測試和執行層級收集的指標記錄檔案。
PerfettoGenericPostProcessor	後置處理器會以遞迴方式展開 proto 訊息和字串值欄位，直到遇到數值欄位為止，藉此將文字/二進位指標 perfetto proto 檔案處理成鍵/值組合。
StatsdGenericPostProcessor	後置處理器，可將二進位值 Proto 統計資料報表處理為鍵/值組合，方法是將報表展開為樹狀結構。

已知間接子類別

StatsdBeforeAfterGaugeMetricPostProcessor、StatsdEventMetricPostProcessor

StatsdBeforeAfterGaugeMetricPostProcessor	後續處理器會處理以「前後」方式收集的評估指標，也就是
StatsdEventMetricPostProcessor	後置處理器，可使用處理器上指定的格式化工具，將 statsd 報表中的事件指標轉換為鍵/值組合。

每個實作項目都應擴充的基本 IPostProcessor。請務必在最終結果回報器之前呼叫後置處理方法。

摘要

公用建構函式
`BasePostProcessor()`

公用方法
`final ITestInvocationListener`	`init(ITestInvocationListener listener)` 後置處理器的初始化步驟。
`final void`	`invocationEnded(long elapsedTime)` 回報叫用已終止，無論是成功或因某些錯誤條件而終止。
`final void`	`invocationFailed(FailureDescription failure)` 由於某些錯誤情況，系統會回報未完成的叫用作業。
`final void`	`invocationFailed(Throwable cause)` 由於某些錯誤情況，系統會回報未完成的叫用作業。
`void`	`invocationSkipped(SkipReason reason)` 將叫用動作回報為略過
`final void`	`invocationStarted(IInvocationContext context)` 用於轉送的叫用事件監聽器
`final boolean`	`isDisabled()` 如果整個物件已停用 (略過設定和拆卸)，則傳回 True。
`final void`	`logAssociation(String dataName, LogFile logFile)` 在某些情況下，記錄必須與測試案例建立強烈關聯，但無法直接在 `testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile)` 回呼中執行這項操作。更新記錄與測試的關聯。
	`processAllTestMetricsAndLogs(ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, allTestLogs)` 實作此方法，匯總所有測試的指標和記錄。
`abstract`	`processRunMetricsAndLogs( rawMetrics, runLogs)` 實作此方法，即可從現有指標和記錄產生一組新指標。
	`processTestMetricsAndLogs(TestDescription testDescription, testMetrics, testLogs)` 實作此方法，以便從每項測試中後處理指標和記錄。
`final void`	`setLogSaver(ILogSaver logSaver)` 設定 `ILogSaver`，允許實作者儲存檔案。
`void`	`setUp()` 在子後置處理器中覆寫此方法，以便在測試執行前進行初始化。
`final void`	`testAssumptionFailure(TestDescription test, String trace)` 當原子測試標記假設條件為 false 時，系統會呼叫此方法
`final void`	`testAssumptionFailure(TestDescription test, FailureDescription failure)` 當原子測試標記假設條件為 false 時，系統會呼叫此方法
`final void`	`testEnded(TestDescription test, long endTime, testMetrics)` `ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map))` 的替代方案，可直接指定結束時間。
`final void`	`testEnded(TestDescription test, testMetrics)` 回報個別測試案例的執行結束時間。
`final void`	`testFailed(TestDescription test, FailureDescription failure)` 回報個別測試案例的失敗情形。
`final void`	`testFailed(TestDescription test, String trace)` 回報個別測試案例的失敗情形。
`final void`	`testIgnored(TestDescription test)` 在測試不會執行時呼叫，通常是因為測試方法已標註為 org.junit.Ignore。
`final void`	`testLog(String dataName, LogDataType dataType, InputStreamSource dataStream)` 使用這個方法，從 PostProcessor 實作記錄檔案。
`final void`	`testLogSaved(String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)` 儲存測試記錄時呼叫。
`final void`	`testModuleEnded()` 回報模組執行作業結束。
`final void`	`testModuleStarted(IInvocationContext moduleContext)` 回報模組開始執行的時間。
`final void`	`testRunEnded(long elapsedTime, runMetrics)` 回報測試執行結束。
`final void`	`testRunFailed(FailureDescription failure)` 由於 `FailureDescription` 所述的錯誤，無法完成報表測試執行作業。
`final void`	`testRunFailed(String errorMessage)` 由於發生致命錯誤，報表測試執行作業無法完成。
`final void`	`testRunStarted(String runName, int testCount, int attemptNumber)` 回報測試執行作業的開始時間。
`final void`	`testRunStarted(String runName, int testCount)` 測試執行回呼
`final void`	`testRunStarted(String runName, int testCount, int attemptNumber, long startTime)` 回報測試執行作業的開始時間。
`final void`	`testRunStopped(long elapsedTime)` 報表測試在使用者要求下，在完成前停止執行。
`final void`	`testSkipped(TestDescription test, SkipReason reason)` 當測試遭到略過，且未因通常預期的原因而執行時，系統會呼叫此方法。
`final void`	`testStarted(TestDescription test, long startTime)` `testStarted(com.android.tradefed.result.TestDescription)` 的替代方案，我們也會指定測試開始時間，並搭配 `ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map))` 進行精確評估。
`final void`	`testStarted(TestDescription test)` 測試案例回呼

受保護的方法
`void`	`cleanUp()`
`MetricMeasurement.DataType`	`getMetricType()` 如有需要，請覆寫此方法來變更指標類型。
`String`	`getRunName()`

公用建構函式

BasePostProcessor

public BasePostProcessor ()

公用方法

init

public final ITestInvocationListener init (ITestInvocationListener listener)

後置處理器的初始化步驟。請務必在任何測試回呼之前呼叫。

參數
`listener`	`ITestInvocationListener`

傳回
`ITestInvocationListener`

invocationEnded

public final void invocationEnded (long elapsedTime)

回報叫用已終止，無論是成功或因某些錯誤條件而終止。

會由 TradeFederation 架構自動呼叫。

參數
`elapsedTime`	`long`：叫用作業的經過時間 (以毫秒為單位)

invocationFailed

public final void invocationFailed (FailureDescription failure)

由於某些錯誤情況，因此回報未完成的叫用作業。

會由 TradeFederation 架構自動呼叫。

參數
`failure`	`FailureDescription`：描述失敗原因的 `FailureDescription`

invocationFailed

public final void invocationFailed (Throwable cause)

由於某些錯誤情況，因此回報未完成的叫用作業。

會由 TradeFederation 架構自動呼叫。

參數
`cause`	`Throwable`：失敗的 `Throwable` 原因

invocationSkipped

public void invocationSkipped (SkipReason reason)

將叫用動作回報為略過

參數
`reason`	`SkipReason`

invocationStarted

public final void invocationStarted (IInvocationContext context)

用於轉送的叫用事件監聽器

參數
`context`	`IInvocationContext`：叫用作業相關資訊

isDisabled

public final boolean isDisabled ()

如果整個物件已停用 (略過設定和拆卸)，則傳回 True。否則為 False。

傳回
`boolean`

logAssociation

public final void logAssociation (String dataName, 
                LogFile logFile)

在某些情況下，記錄必須與測試案例建立強烈關聯，但無法直接在 testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile) 回呼上執行此操作。因此，這個回呼可明確提供強大關聯。

更新記錄與測試的關聯。如果在測試期間呼叫此方法，則記錄屬於測試；否則，則是執行記錄。

參數
`dataName`	`String`：資料名稱
`logFile`	`LogFile`：先前記錄的 `LogFile`，應與測試案例相關聯。

processAllTestMetricsAndLogs

public  processAllTestMetricsAndLogs (ListMultimap<String, MetricMeasurement.Metric> allTestMetrics, 
                 allTestLogs)

實作此方法，匯總所有測試的指標和記錄。這個方法產生的指標會以執行指標的形式回報。請只傳回新產生的指標，並附上專屬的鍵名稱 (不得與現有鍵重複)。

參數
`allTestMetrics`	`ListMultimap`：HashMultimap，用於儲存各項測試的指標，並依指標名稱分組。
`allTestLogs`	：儲存每個測試的記錄檔案地圖，並以資料名稱做為索引，使用每個測試的 `TestDescription` 做為索引鍵。

傳回
	從所有測試指標新產生的指標組合。

processRunMetricsAndLogs

public abstract  processRunMetricsAndLogs ( rawMetrics, 
                 runLogs)

實作此方法，即可從現有指標和記錄產生一組新指標。請只傳回新產生的指標，並附上專屬的鍵名稱 (不得與現有鍵重複)。

參數
`rawMetrics`	：可用於執行作業的原始指標集。
`runLogs`	：測試執行作業的一系列記錄檔案。

傳回
	從執行指標新產生的指標組合。

processTestMetricsAndLogs

public  processTestMetricsAndLogs (TestDescription testDescription, 
                 testMetrics, 
                 testLogs)

實作此方法，以便從每項測試中後處理指標和記錄。請只傳回新產生的指標，並附上專屬的鍵名稱 (不得與現有鍵重複)。

參數
`testDescription`	`TestDescription`：描述測試的 TestDescription 物件。
`testMetrics`	：測試的一系列指標。
`testLogs`	：測試期間記錄的檔案集合。

傳回
	從測試指標新產生的指標組合。

setLogSaver

public final void setLogSaver (ILogSaver logSaver)

設定 ILogSaver，允許實作者儲存檔案。

參數
`logSaver`	`ILogSaver`：`ILogSaver`

setUp

public void setUp ()

在子後置處理器中覆寫此方法，以便在測試執行前進行初始化。

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                String trace)

當原子測試標記假設條件為 false 時，系統會呼叫此方法

參數
`test`	`TestDescription`：用於識別測試
`trace`	`String`：失敗的堆疊追蹤

testAssumptionFailure

public final void testAssumptionFailure (TestDescription test, 
                FailureDescription failure)

當原子測試標記假設條件為 false 時，系統會呼叫此方法

參數
`test`	`TestDescription`：用於識別測試
`failure`	`FailureDescription`：`FailureDescription` 可說明失敗和其情境。

testEnded

public final void testEnded (TestDescription test, 
                long endTime, 
                 testMetrics)

ERROR(/#testEnded(com.android.tradefed.result.TestDescription,Map)) 的替代方案，可直接指定結束時間。搭配 testStarted(com.android.tradefed.result.TestDescription, long) 使用，可獲得精確的測量結果。

參數
`test`	`TestDescription`：用於識別測試
`endTime`	`long`：測試結束的時間，透過 `System.currentTimeMillis()` 測量
`testMetrics`	：傳送指標的 `ERROR(/Map)`

testEnded

public final void testEnded (TestDescription test, 
                 testMetrics)

回報個別測試案例的執行結束時間。

如果未叫用 testFailed(TestDescription, FailureDescription)，則表示這項測試已通過。也會傳回在測試案例執行期間可能已發出的任何鍵/值指標。

參數
`test`	`TestDescription`：用於識別測試
`testMetrics`	：傳送指標的 `ERROR(/Map)`

testFailed

public final void testFailed (TestDescription test, 
                FailureDescription failure)

回報個別測試案例的失敗情形。

會在 testStarted 和 testEnded 之間呼叫。

參數
`test`	`TestDescription`：用於識別測試
`failure`	`FailureDescription`：`FailureDescription` 可說明失敗和其情境。

testFailed

public final void testFailed (TestDescription test, 
                String trace)

回報個別測試案例的失敗情形。

會在 testStarted 和 testEnded 之間呼叫。

參數
`test`	`TestDescription`：用於識別測試
`trace`	`String`：失敗的堆疊追蹤

testIgnored

public final void testIgnored (TestDescription test)

當測試不會執行時，系統會呼叫此方法，通常是因為測試方法已標註為 org.junit.Ignore。

參數
`test`	`TestDescription`：用於識別測試

testLog

public final void testLog (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream)

使用這個方法，從 PostProcessor 實作記錄檔案。

參數
`dataName`	`String`：資料的 `String` 描述性名稱，例如「device_logcat」。請注意，每個叫用動作的 dataName 可能不具唯一性。也就是說，實作者必須能夠處理具有相同 dataName 的多個呼叫
`dataType`	`LogDataType`：資料的 `LogDataType`
`dataStream`	`InputStreamSource`：資料的 `InputStreamSource`。實作者應呼叫 createInputStream 開始讀取資料，並確保在完成時關閉產生的 InputStream。呼叫端應確保資料來源持續存在且可供存取，直到 testLog 方法完成為止。

testLogSaved

public final void testLogSaved (String dataName, 
                LogDataType dataType, 
                InputStreamSource dataStream, 
                LogFile logFile)

儲存測試記錄時呼叫。

應改用 ITestInvocationListener.testLog(String, LogDataType, InputStreamSource)。

參數
`dataName`	`String`：資料的 `String` 描述性名稱，例如「device_logcat」。請注意，每個叫用作業的 dataName 可能不具唯一性。也就是說，實作者必須能夠處理具有相同 dataName 的多個呼叫
`dataType`	`LogDataType`：資料的 `LogDataType`
`dataStream`	`InputStreamSource`：資料的 `InputStreamSource`。實作者應呼叫 createInputStream 開始讀取資料，並確保在完成時關閉產生的 InputStream。
`logFile`	`LogFile`：包含儲存檔案中繼資料的 `LogFile`。

testModuleEnded

public final void testModuleEnded ()

回報模組執行作業結束。

testModuleStarted

public final void testModuleStarted (IInvocationContext moduleContext)

回報模組開始執行的時間。這個回呼與 testModuleEnded() 相關聯，在序列中為選用項目。這個屬性只會在使用模組：套件式執行程式的執行期間使用。

參數
`moduleContext`	`IInvocationContext`：模組的 `IInvocationContext`。

testRunEnded

public final void testRunEnded (long elapsedTime, 
                 runMetrics)

回報測試執行結束。

參數
`elapsedTime`	`long`：裝置回報的經過時間，以毫秒為單位
`runMetrics`	：測試執行結束時回報的鍵/值組合

testRunFailed

public final void testRunFailed (FailureDescription failure)

由於 FailureDescription 所述的錯誤，導致報表測試執行作業無法完成。

參數
`failure`	`FailureDescription`：`FailureDescription` 可說明失敗和其情境。

testRunFailed

public final void testRunFailed (String errorMessage)

由於發生致命錯誤，報表測試執行作業無法完成。

參數
`errorMessage`	`String`：`String`，說明執行失敗的原因。

testRunStarted

public final void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber)

回報測試執行作業的開始時間。

參數
`runName`	`String`：測試執行作業名稱
`testCount`	`int`：測試執行作業中的測試總數
`attemptNumber`	`int`：訂單號碼，用於識別同一個 runName 執行多次的不同嘗試。attemptNumber 的索引為 0，每次執行時都應遞增。舉例來說，如果測試重試 3 次，則在相同的 runName 下，應有 4 次執行，而 attemptNumber 則從 0 到 3。

testRunStarted

public final void testRunStarted (String runName, 
                int testCount)

測試執行回呼

參數
`runName`	`String`：測試執行作業名稱
`testCount`	`int`：測試執行作業中的測試總數

testRunStarted

public final void testRunStarted (String runName, 
                int testCount, 
                int attemptNumber, 
                long startTime)

回報測試執行作業的開始時間。

參數
`runName`	`String`：測試執行作業名稱
`testCount`	`int`：測試執行作業中的測試總數
`attemptNumber`	`int`：訂單號碼，用於識別同一個 runName 執行多次的不同嘗試。attemptNumber 的索引為 0，每次執行時都應遞增。舉例來說，如果測試重試 3 次，則在相同的 runName 下，應有 4 次執行，而 attemptNumber 則從 0 到 3。
`startTime`	`long`：透過 `System.currentTimeMillis()` 測量的執行作業開始時間

testRunStopped

public final void testRunStopped (long elapsedTime)

報表測試在使用者要求下，在完成前停止執行。

TODO：目前未使用，建議移除

參數
`elapsedTime`	`long`：裝置回報的經過時間，以毫秒為單位

testSkipped

public final void testSkipped (TestDescription test, 
                SkipReason reason)

當測試遭到略過，且未因通常預期的原因而執行時，系統會呼叫此方法。系統會嘗試重試這些測試，以便取得正確的執行結果。

參數
`test`	`TestDescription`：用於識別測試
`reason`	`SkipReason`：`SkipReason`

testStarted

public final void testStarted (TestDescription test, 
                long startTime)

testStarted(com.android.tradefed.result.TestDescription) 的替代方案，我們也會指定測試開始時間，並搭配 ERROR(/#testEnded(com.android.tradefed.result.TestDescription,long,Map)) 進行精確評估。

參數
`test`	`TestDescription`：用於識別測試
`startTime`	`long`：測試開始的時間，透過 `System.currentTimeMillis()` 測量

testStarted

public final void testStarted (TestDescription test)

測試案例回呼

參數
`test`	`TestDescription`：用於識別測試

受保護的方法

cleanUp

protected void cleanUp ()

getMetricType

protected MetricMeasurement.DataType getMetricType ()

如有需要，請覆寫此方法來變更指標類型。預設指標設為已處理的類型。

傳回
`MetricMeasurement.DataType`

getRunName

protected String getRunName ()

傳回
`String`