ILogSaver

public interface ILogSaver

com.android.tradefed.result.ILogSaver

既知の間接的なサブクラス ATestFileSystemLogSaver、ClusterLogSaver、FileSystemLogSaver ATestFileSystemLogSaver この LogSaver クラスは、ATest が特定のパスにログを保存するために使用します。  ClusterLogSaver テスト出力を TFC にアップロードする ILogSaver クラス。  FileSystemLogSaver ログをファイル システムに保存します。

---

このインターフェースを実装するクラスは、ログを一元的な場所に保存するためのメソッドを提供します。

ILogSaver は構成で宣言され、ログを一元的な場所に保存します。また、ILogSaverListener が同じ場所に追加のファイルを保存できるようにメソッドも公開します。

概要

パブリック メソッド
abstract LogFile	getLogReportDir() ログが保存されるディレクトリのパスまたは URL を含む LogFile を取得します。
default void	init(IInvocationContext context) ビルド情報が利用可能になる前に、初期化の早期通知。
abstract void	invocationEnded(long elapsedTime) 呼び出しが正常に終了したか、なんらかのエラー状態が原因で終了したかを報告します。
abstract void	invocationStarted(IInvocationContext context) テスト呼び出しの開始を報告します。
abstract LogFile	saveLogData(String dataName, LogDataType dataType, InputStream dataStream) ログデータを保存します。
default LogFile	saveLogDataRaw(String dataName, LogDataType dataType, InputStream dataStream) このメソッドは非推奨です。 代わりに saveLogData(String, com.android.tradefed.result.LogDataType, InputStream) を使用してください
default LogFile	saveLogFile(String dataName, LogDataType dataType, File fileToLog) ログファイルを保存します。

パブリック メソッド

getLogReportDir

public abstract LogFile getLogReportDir ()

ログが保存されるディレクトリのパスまたは URL を含む LogFile を取得します。

戻り値
LogFile	LogFile。

init

public void init (IInvocationContext context)

ビルド情報が利用可能になる前に、初期化の早期通知。これにより、ログを受信するための要件を設定できます。

パラメータ
context	IInvocationContext: 呼び出しに関する情報。

invocationEnded

public abstract void invocationEnded (long elapsedTime)

呼び出しが正常に終了したか、なんらかのエラー条件が原因で終了したかを報告します。

ITestInvocationListener.invocationEnded(long) が呼び出されると、TradeFederation フレームワークによって自動的に呼び出されます。

パラメータ
elapsedTime	long: 呼び出しの所要時間（ミリ秒単位）

invocationStarted

public abstract void invocationStarted (IInvocationContext context)

テスト呼び出しの開始を報告します。

ITestInvocationListener.invocationStarted(IInvocationContext) が呼び出される前に、TradeFederation フレームワークによって自動的に呼び出されます。

パラメータ
context	IInvocationContext: 呼び出しに関する情報。

saveLogData

public abstract LogFile saveLogData (String dataName, 
                LogDataType dataType, 
                InputStream dataStream)

ログデータを保存します。

ITestLogger.testLog(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource) が呼び出されるたびに、TradeFederation フレームワークによって自動的に呼び出されます。追加のログデータを保存するヘルパー メソッドとして使用することもできます。

実装とポリシーによっては、ログが圧縮形式で保存される場合があります。ログが Tradefed からアクセスできない場所に保存されている場合もあります。

パラメータ
dataName	String: データのわかりやすい名前（String）。例: device_logcat
dataType	LogDataType: ファイルの LogDataType。
dataStream	InputStream: データの ERROR(/InputStream)。

戻り値
LogFile	保存したファイルのパスと URL を含む LogFile。

例外
	ログファイルを生成できなかった場合

saveLogDataRaw

public LogFile saveLogDataRaw (String dataName, 
                LogDataType dataType, 
                InputStream dataStream)

このメソッドは非推奨です。
代わりに saveLogData(String, com.android.tradefed.result.LogDataType, InputStream) を使用してください

ログデータを変更せずに保存するヘルパー メソッド。

ログは、Tradefed がアクセスできない場所に保存される場合があります。

パラメータ
dataName	String: データのわかりやすい名前（例: device_logcat）。String
dataType	LogDataType: ファイルのタイプと拡張子を含む LogDataType
dataStream	InputStream: データの ERROR(/InputStream)。

戻り値
LogFile	保存したファイルのパスと URL を含む LogFile。

例外
	ログファイルを生成できなかった場合

saveLogFile

public LogFile saveLogFile (String dataName, 
                LogDataType dataType, 
                File fileToLog)

ログファイルを保存します。

ITestLogger.testLog(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource) が呼び出され、ストリームがファイルを参照するたびに、TradeFederation フレームワークによって自動的に呼び出されます。

実装とポリシーによっては、ログが圧縮形式で保存される場合があります。ログが Tradefed からアクセスできない場所に保存されている場合もあります。

パラメータ
dataName	String: データのわかりやすい名前（String）。例: device_logcat
dataType	LogDataType: ファイルの LogDataType。
fileToLog	File: 保存する ERROR(/File)。

戻り値
LogFile	保存したファイルのパスと URL を含む LogFile。

例外
	ログファイルを生成できなかった場合