edu.rice.cs.plt.debug
Class TreeLogSink

java.lang.Object
  edu.rice.cs.plt.debug.TextLogSink
      edu.rice.cs.plt.debug.TreeLogSink

All Implemented Interfaces:

LogSink, Closeable

public class TreeLogSink
extends TextLogSink

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

TreeLogSink(String name)
Convenience constructor, with exitOnClose set to false.

TreeLogSink(String name, boolean exitOnClose)

Method Summary

void	close()
static Thunk<TreeLogSink>	factory(String name) Create a serializable TreeLogSink factory.
static Thunk<TreeLogSink>	factory(String name, boolean exitOnClose)
protected void	write(LogSink.Message m, SizedIterable<String> text) Record the given message, the body of which is described by the given lines of text.
protected void	writeEnd(LogSink.EndMessage m, SizedIterable<String> text) Record the given end message, the body of which is described by the given lines of text.
protected void	writeStart(LogSink.StartMessage m, SizedIterable<String> text) Record the given start message, the body of which is described by the given lines of text.

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

TreeLogSink

public TreeLogSink(String name)

Convenience constructor, with exitOnClose set to false.

TreeLogSink

public TreeLogSink(String name,
                   boolean exitOnClose)

Parameters:

name - Name to use in the window title

exitOnClose - Whether System.exit(int) should be invoked when the last open tree window is closed

Method Detail

close

public void close()

write

protected void write(LogSink.Message m,
                     SizedIterable<String> text)

Description copied from class: TextLogSink

Record the given message, the body of which is described by the given lines of text. Subclasses should ensure that the effects of this method appear to be atomic (at least within the context of concurrent invocations of this method). This can be trivially achieved by declaring the method synchronized.

Specified by:

write in class TextLogSink

writeStart

protected void writeStart(LogSink.StartMessage m,
                          SizedIterable<String> text)

Description copied from class: TextLogSink

Record the given start message, the body of which is described by the given lines of text. Subclasses should ensure that the effects of this method appear to be atomic (at least within the context of concurrent invocations of this method). This can be trivially achieved by declaring the method synchronized.

Specified by:

writeStart in class TextLogSink

writeEnd

protected void writeEnd(LogSink.EndMessage m,
                        SizedIterable<String> text)

Description copied from class: TextLogSink

Record the given end message, the body of which is described by the given lines of text. Subclasses should ensure that the effects of this method appear to be atomic (at least within the context of concurrent invocations of this method). This can be trivially achieved by declaring the method synchronized.

Specified by:

writeEnd in class TextLogSink

factory

public static Thunk<TreeLogSink> factory(String name)

Create a serializable TreeLogSink factory. (For compatibility with RMILogSink.)

factory

public static Thunk<TreeLogSink> factory(String name,
                                         boolean exitOnClose)