LogFileSaver
public class LogFileSaver
extends Object
| java.lang.Object | |
| ↳ | com.android.tradefed.result.LogFileSaver |
Вспомогательная функция для ITestInvocationListener , которая будет сохранять данные лога в файл.
Краткое содержание
Государственные строители | |
|---|---|
LogFileSaver ( IBuildInfo buildInfo, File rootDir) Создает объект | |
LogFileSaver ( IBuildInfo buildInfo, File rootDir, Integer logRetentionDays) Создает объект | |
LogFileSaver ( IBuildInfo buildInfo, File rootDir, Integer logRetentionDays, Boolean containInvDir) Создает объект | |
LogFileSaver (File rootDir) Альтернативный конструктор | |
Общедоступные методы | |
|---|---|
File | createCompressedLogFile (String dataName, LogDataType origDataType)Создает пустой файл для хранения сжатых данных журнала. |
OutputStream | createGZipLogStream (File logFile)Создает выходной поток для записи данных, сжатых в формате GZIP, в файл. |
InputStream | createInputStreamFromFile (File logFile)Вспомогательный метод для создания входного потока для чтения содержимого заданного лог-файла. TODO: рассмотреть возможность переноса этого метода в другое место. |
File | getFileDir ()Укажите каталог, используемый для хранения файлов. |
List<String> | getInvocationLogPathSegments () |
File | saveAndGZipLogData (String dataName, LogDataType dataType, InputStream dataStream)При необходимости сохраните и сожмите данные журнала в файл gzip. |
File | saveAndGZipLogFile (String dataName, LogDataType dataType, File fileToLog)При необходимости сохраните и сожмите данные журнала в файл gzip. |
File | saveLogData (String dataName, LogDataType dataType, InputStream dataStream)Сохраните данные журнала в файл. |
File | saveLogDataRaw (String dataName, String ext, InputStream dataStream)Сохраните исходные данные в файл. |
File | saveLogFile (String dataName, LogDataType dataType, File fileToLog)Сохранить указанный файл журнала |
Государственные строители
LogFileSaver
public LogFileSaver (IBuildInfo buildInfo, File rootDir)
Создает объект LogFileSaver .
| Параметры | |
|---|---|
buildInfo | IBuildInfo : IBuildInfo |
rootDir | File : путь к корневому каталогу файловой системы. |
LogFileSaver
public LogFileSaver (IBuildInfo buildInfo, File rootDir, Integer logRetentionDays)
Создает объект LogFileSaver .
Создайте уникальный каталог файловой системы в rootDir/branch/build_id/testTag/uniqueDir
Если создание каталога не удастся, будет использован временный каталог.
| Параметры | |
|---|---|
buildInfo | IBuildInfo : IBuildInfo |
rootDir | File : путь к корневому каталогу файловой системы. |
logRetentionDays | Integer : Если указан файл '.retention', в каталог логов будет записан файл с меткой времени, равной текущему времени + logRetentionDays. Внешние скрипты очистки могут использовать этот файл для определения момента удаления каталогов логов. |
LogFileSaver
public LogFileSaver (IBuildInfo buildInfo, File rootDir, Integer logRetentionDays, Boolean containInvDir)
Создает объект LogFileSaver .
Создайте уникальный каталог файловой системы в rootDir/branch/build_id/testTag/uniqueDir
Если создание каталога не удастся, будет использован временный каталог.
| Параметры | |
|---|---|
buildInfo | IBuildInfo : IBuildInfo |
rootDir | File : путь к корневому каталогу файловой системы. |
logRetentionDays | Integer : Если указан файл '.retention', в каталог логов будет записан файл с меткой времени, равной текущему времени + logRetentionDays. Внешние скрипты очистки могут использовать этот файл для определения момента удаления каталогов логов. |
containInvDir | Boolean |
LogFileSaver
public LogFileSaver (File rootDir)
Альтернативный конструктор LogFileSaver , который будет использовать указанную директорию в качестве каталога для хранения логов.
Общедоступные методы
создатьСжатыйФайлЛог
public File createCompressedLogFile (String dataName,
LogDataType origDataType)Создает пустой файл для хранения сжатых данных журнала.
| Параметры | |
|---|---|
dataName | String : String описательное имя данных, которые будут сохранены. |
origDataType | LogDataType : тип LogDataType , который будет сохранен. |
| Возвраты | |
|---|---|
File | File |
| Броски | |
|---|---|
IOException | если файл журнала не удалось создать |
createGZipLogStream
public OutputStream createGZipLogStream (File logFile)
Создает выходной поток для записи данных, сжатых в формате GZIP, в файл.
| Параметры | |
|---|---|
logFile | File : File в который нужно записать данные. |
| Возвраты | |
|---|---|
OutputStream | OutputStream используется для сжатия и записи данных в файл. Этот поток будет использован после завершения процесса. |
| Броски | |
|---|---|
IOException | если поток не удалось сгенерировать |
createInputStreamFromFile
public InputStream createInputStreamFromFile (File logFile)
Вспомогательный метод для создания входного потока для чтения содержимого заданного лог-файла.
TODO: рассмотреть возможность переноса этого метода в другое место. Пока что он размещен здесь, чтобы пользователи этого класса могли его имитировать.| Параметры | |
|---|---|
logFile | File : File , из которого нужно прочитать данные. |
| Возвраты | |
|---|---|
InputStream | Буферизованный InputStream для чтения данных из файла. Вызывающие стороны должны обратиться к этому потоку после завершения его работы. |
| Броски | |
|---|---|
IOException | если поток не удалось сгенерировать |
getFileDir
public File getFileDir ()
Укажите каталог, используемый для хранения файлов.
| Возвраты | |
|---|---|
File | Каталог File |
getInvocationLogPathSegments
public List<String> getInvocationLogPathSegments ()
| Возвраты | |
|---|---|
List<String> | уникальные сегменты пути к журналу вызовов. |
saveAndGZipLogData
public File saveAndGZipLogData (String dataName,
LogDataType dataType,
InputStream dataStream)При необходимости сохраните и сожмите данные журнала в файл gzip.
| Параметры | |
|---|---|
dataName | String : String описательное имя данных. |
dataType | LogDataType : LogDataType файла. Данные журнала, которые являются сжатыми (т.е. LogDataType.isCompressed() равно true ). |
dataStream | InputStream : InputStream данных. |
| Возвраты | |
|---|---|
File | файл сгенерированных данных |
| Броски | |
|---|---|
IOException | если файл журнала не удалось создать |
saveAndGZipLogFile
public File saveAndGZipLogFile (String dataName,
LogDataType dataType,
File fileToLog)При необходимости сохраните и сожмите данные журнала в файл gzip.
| Параметры | |
|---|---|
dataName | String : String описательное имя данных. |
dataType | LogDataType : LogDataType файла. Данные журнала, которые являются сжатыми (т.е. LogDataType.isCompressed() равно true ). |
fileToLog | File : File для сохранения |
| Возвраты | |
|---|---|
File | файл сгенерированных данных |
| Броски | |
|---|---|
IOException | если файл журнала не удалось создать |
сохранить ЛогДанные
public File saveLogData (String dataName,
LogDataType dataType,
InputStream dataStream)Сохраните данные журнала в файл.
| Параметры | |
|---|---|
dataName | String : String описательное имя данных. |
dataType | LogDataType : LogDataType файла (LogDataType). |
dataStream | InputStream : InputStream данных. |
| Возвраты | |
|---|---|
File | файл сгенерированных данных |
| Броски | |
|---|---|
IOException | если файл журнала не удалось создать |
saveLogDataRaw
public File saveLogDataRaw (String dataName,
String ext,
InputStream dataStream)Сохраните исходные данные в файл.
| Параметры | |
|---|---|
dataName | String : String описательное имя данных. |
ext | String : расширение даты |
dataStream | InputStream : InputStream данных. |
| Возвраты | |
|---|---|
File | файл сгенерированных данных |
| Броски | |
|---|---|
IOException | если файл журнала не удалось создать |
saveLogFile
public File saveLogFile (String dataName,
LogDataType dataType,
File fileToLog)Сохранить указанный файл журнала
| Параметры | |
|---|---|
dataName | String : String описательное имя данных. |
dataType | LogDataType : LogDataType файла (LogDataType). |
fileToLog | File : File , который необходимо записать в журнал. |
| Возвраты | |
|---|---|
File | файл сгенерированных данных |
| Броски | |
|---|---|
IOException | если файл журнала не удалось создать |