Package com.atlassian.bamboo.build.logger

Class BuildLogFileWriter

java.lang.Object

com.atlassian.bamboo.build.logger.BuildLogFileWriter

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

@NotThreadSafe
public class BuildLogFileWriter
extends Object
implements Closeable, Flushable

Class to encapsulate streaming of build logs. The writer is opened on creation of the BuildLogFileWriter and a call to close() must be made when finished writing. This class is deliberately made not thread safe.

Constructor Summary

Constructors

Constructor	Description
BuildLogFileWriter(File logFile, @NotNull ExpiryTicker expiryTicker)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the writer to the log file.
void	flush()
void	writeLog(@NotNull LogEntry logEntry)	Writes one line of logs to the log file
void	writeVerbatim(@NotNull String text)	Writes a text to a log file without any changes.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BuildLogFileWriter

public BuildLogFileWriter(File logFile,
                          @NotNull
                          @NotNull ExpiryTicker expiryTicker)

Method Detail

writeLog

public void writeLog(@NotNull
                     @NotNull LogEntry logEntry)
              throws IOException

Writes one line of logs to the log file

Parameters:

logEntry - to be written to file

Throws:

IOException - if errors accessing the file

writeVerbatim

public void writeVerbatim(@NotNull
                          @NotNull String text)
                   throws IOException

Writes a text to a log file without any changes.

Throws:

IOException

close

public void close()
           throws IOException

Closes the writer to the log file. Must be called when writing complete

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - if problems closing the file

flush

public void flush()
           throws IOException

Specified by:

flush in interface Flushable

Throws:

IOException