com.ryanm.logging
Interface LogSink

All Superinterfaces:
Configurable
All Known Implementing Classes:
AbstractSink, FileSink, LogTerminal, StreamSink, StringSink

public interface LogSink
extends Configurable

The end of the journey for a log message

Author:
ryanm

Method Summary
 void addSinkListener(SinkListener listener)
          Adds a listener object to this sink.
 java.lang.String getTitle()
          Gets a title for this sink
 void log(com.ryanm.logging.LogMessage message)
          Logs the specified message to this sink
 void removeSinkListener(SinkListener listener)
          Removes a listener object from this sink.
 
Methods inherited from interface com.ryanm.config.Configurable
getConfigurator
 

Method Detail

getTitle

java.lang.String getTitle()
Gets a title for this sink

Returns:
A title for this sink

log

void log(com.ryanm.logging.LogMessage message)
Logs the specified message to this sink

Parameters:
message - The message to log

addSinkListener

void addSinkListener(SinkListener listener)
Adds a listener object to this sink. The listener will henceforth be advised of any changes to this sink. Duplicate additions of the same listener will be ignored.

Parameters:
listener - The listener to add

removeSinkListener

void removeSinkListener(SinkListener listener)
Removes a listener object from this sink. The listener will henceforth NOT be advised of any changes to this sink. Removals of an unknown listener will be ignored

Parameters:
listener - The listener to remove