ILogSaverListener
public
interface
ILogSaverListener
implements
ITestInvocationListener
com.android.tradefed.result.ILogSaverListener |
Allows for ITestInvocationListener
s to listen for when log files are saved.
This allows for multiple ITestInvocationListener
s to use the same saved log file when
generating reports, and avoids having each listener save the file individually when ITestInvocationListener#testLog(String, LogDataType, InputStreamSource)
is called.
Classes implementing this interface should be aware that testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile)
will be called whenever ITestInvocationListener#testLog(String, LogDataType, InputStreamSource)
is called.
This class also passes the global ILogSaver
instance so ITestInvocationListener
s can save additional files in the same location.
Summary
Public methods | |
---|---|
default
void
|
logAssociation(String dataName, LogFile logFile)
In some cases, log must be strongly associated with a test cases, but the opportunity to do
so on the direct |
default
void
|
setLogSaver(ILogSaver logSaver)
Set the |
default
void
|
testLogSaved(String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)
Called when the test log is saved. |
Public methods
logAssociation
public void logAssociation (String dataName, LogFile logFile)
In some cases, log must be strongly associated with a test cases, but the opportunity to do
so on the direct testLogSaved(String, com.android.tradefed.result.LogDataType, com.android.tradefed.result.InputStreamSource, com.android.tradefed.result.LogFile)
callback is not possible. Thus, this callback allows to provide a strong association
explicitly.
Parameters | |
---|---|
dataName |
String : The name of the data |
logFile |
LogFile : the LogFile that was logged before and should be associated with the
test case.
|
setLogSaver
public void setLogSaver (ILogSaver logSaver)
Set the ILogSaver
to allow the implementor to save files.
Parameters | |
---|---|
logSaver |
ILogSaver : the ILogSaver
|
testLogSaved
public void testLogSaved (String dataName, LogDataType dataType, InputStreamSource dataStream, LogFile logFile)
Called when the test log is saved.
Should be used in place of ITestInvocationListener#testLog(String, LogDataType,
InputStreamSource)
.
Parameters | |
---|---|
dataName |
String : a String descriptive name of the data. e.g. "device_logcat". Note
dataName may not be unique per invocation. ie implementers must be able to handle
multiple calls with same dataName |
dataType |
LogDataType : the LogDataType of the data |
dataStream |
InputStreamSource : the InputStreamSource of the data. Implementers should call
createInputStream to start reading the data, and ensure to close the resulting
InputStream when complete. |
logFile |
LogFile : the LogFile containing the meta data of the saved file.
|