edu.rice.cs.plt.debug
Class FileLogSink

java.lang.Object
  edu.rice.cs.plt.debug.TextLogSink
      edu.rice.cs.plt.debug.IndentedTextLogSink
          edu.rice.cs.plt.debug.FileLogSink

All Implemented Interfaces:

LogSink, java.io.Closeable

public class FileLogSink
extends IndentedTextLogSink

A log sink that writes tagged, indented text to a file. The file is not opened until required for logging, and is closed on program exit.

Nested Class Summary

Nested classes/interfaces inherited from interface edu.rice.cs.plt.debug.LogSink

LogSink.EndMessage, LogSink.ErrorMessage, LogSink.Message, LogSink.MessageVisitor<T>, LogSink.StackMessage, LogSink.StandardMessage, LogSink.StartMessage, LogSink.ValueMessage

Constructor Summary

FileLogSink(java.io.File f)

FileLogSink(java.io.File f, boolean closeOnExit)

FileLogSink(java.io.File f, int idealLineWidth)

FileLogSink(java.io.File f, int idealLineWidth, boolean closeOnExit)

FileLogSink(java.io.File f, java.lang.String charset)

FileLogSink(java.io.File f, java.lang.String charset, boolean closeOnExit)

FileLogSink(java.io.File f, java.lang.String charset, int idealLineWidth)

FileLogSink(java.io.File f, java.lang.String charset, int idealLineWidth, boolean closeOnExit)

FileLogSink(java.lang.String filename)

Method Summary

void	close() Close the file stream.
protected java.io.BufferedWriter	writer(LogSink.Message m) Get a BufferedWriter for outputting the given message.

Methods inherited from class edu.rice.cs.plt.debug.IndentedTextLogSink

write, writeEnd, writeStart

Methods inherited from class edu.rice.cs.plt.debug.TextLogSink

formatLocation, formatLocation, formatThread, formatTime, log, logEnd, logError, logStack, logStart

Methods inherited from class java.lang.Object

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

Constructor Detail

FileLogSink

public FileLogSink(java.lang.String filename)

FileLogSink

public FileLogSink(java.io.File f)

FileLogSink

public FileLogSink(java.io.File f,
                   int idealLineWidth)

FileLogSink

public FileLogSink(java.io.File f,
                   boolean closeOnExit)

FileLogSink

public FileLogSink(java.io.File f,
                   int idealLineWidth,
                   boolean closeOnExit)

FileLogSink

public FileLogSink(java.io.File f,
                   java.lang.String charset)

FileLogSink

public FileLogSink(java.io.File f,
                   java.lang.String charset,
                   boolean closeOnExit)

FileLogSink

public FileLogSink(java.io.File f,
                   java.lang.String charset,
                   int idealLineWidth)

FileLogSink

public FileLogSink(java.io.File f,
                   java.lang.String charset,
                   int idealLineWidth,
                   boolean closeOnExit)

Method Detail

writer

protected java.io.BufferedWriter writer(LogSink.Message m)

Description copied from class: IndentedTextLogSink

Get a BufferedWriter for outputting the given message.

Specified by:

writer in class IndentedTextLogSink

close

public void close()
           throws java.io.IOException

Close the file stream.

Throws:

java.io.IOException