EAF 7.6 API

com.lutris.logging
Class LogWriter

java.lang.Object
  extended by java.io.Writer
      extended by java.io.PrintWriter
          extended by com.lutris.logging.LogWriter
All Implemented Interfaces:
java.io.Closeable, java.io.Flushable, java.lang.Appendable

public class LogWriter
extends java.io.PrintWriter

Class use to write log output to a particular LogChannel and level. This class is PrintWriter, with println() causing a write. One should use println() with this rather than write, as with a LogChannel, since write doesn't write a full line.


Field Summary
 
Fields inherited from class java.io.PrintWriter
out
 
Fields inherited from class java.io.Writer
lock
 
Constructor Summary
protected LogWriter(LogChannel logChannel, int logLevel)
          Constructor.
protected LogWriter(LogChannel logChannel, java.lang.String logLevel)
          Constructor.
 
Method Summary
 LogChannel getChannel()
          Get the associate channel.
 int getLevel()
          Get the associate level.
 boolean isEnabled()
          Determine if logging is enabled.
 void println(java.lang.String msg, java.lang.Throwable throwable)
          Write a string and exception to the log file.
 
Methods inherited from class java.io.PrintWriter
append, append, append, checkError, clearError, close, flush, format, format, print, print, print, print, print, print, print, print, print, printf, printf, println, println, println, println, println, println, println, println, println, println, setError, write, write, write, write, write
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LogWriter

protected LogWriter(LogChannel logChannel,
                    java.lang.String logLevel)
Constructor.

Parameters:
logChannel - The log channel to write to.
logLevel - The level associated with this channel.

LogWriter

protected LogWriter(LogChannel logChannel,
                    int logLevel)
Constructor.

Parameters:
logChannel - The log channel to write to.
logLevel - The level associated with this channel.
Method Detail

getChannel

public LogChannel getChannel()
Get the associate channel.


getLevel

public int getLevel()
Get the associate level.


isEnabled

public boolean isEnabled()
Determine if logging is enabled. This is useful to prevent a series of unnecessary logging calls, as often encountered with debug logging, or a call where generating the message is expensive.

Returns:
true if enabled, false if not enabled.

println

public void println(java.lang.String msg,
                    java.lang.Throwable throwable)
Write a string and exception to the log file.

Parameters:
msg - The message to log.
throwable - Exception or error to log.

EAF 7.6 API