Enhydra 5.1 API

com.lutris.logging
Class StandardLogChannel

java.lang.Object
  |
  +--com.lutris.logging.StandardLogChannel
All Implemented Interfaces:
LogChannel

public class StandardLogChannel
extends java.lang.Object
implements LogChannel

Standard implementation of a channel associated with a logging facility. All messages for the facility are written using a channel. Care is take to avoid synchronization when possible for performance reasons.

Author:
Mark Diekhans
See Also:
LogChannel, StandardLogger

Constructor Summary
protected StandardLogChannel(java.lang.String chanFacility, StandardLogger loggerObj)
          Construct a new log channel.
 
Method Summary
 int getLevel(java.lang.String level)
          Convert a symbolic level to an integer identifier.
 LogWriter getLogWriter(int level)
           
 LogWriter getLogWriter(java.lang.String level)
           
 boolean isEnabled(int level)
          Determine if logging is enabled for the specified level.
 boolean isEnabled(java.lang.String level)
          Determine if logging is enabled for the specified level.
 void write(int level, java.lang.String msg)
          Write a string to the log file.
 void write(int level, java.lang.String msg, java.lang.Throwable throwable)
          Write a string and exception to the log file.
 void write(java.lang.String level, java.lang.String msg)
          Write a string to the log file.
 void write(java.lang.String level, java.lang.String msg, java.lang.Throwable throwable)
          Write a string and exception to the log file.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

StandardLogChannel

protected StandardLogChannel(java.lang.String chanFacility,
                             StandardLogger loggerObj)
Construct a new log channel.

Parameters:
chanFacility - The facility that the channel is associate with.
loggerObj - The logging object that this channel will be associated with.
Method Detail

getLevel

public int getLevel(java.lang.String level)
Description copied from interface: LogChannel
Convert a symbolic level to an integer identifier.

Specified by:
getLevel in interface LogChannel
Parameters:
level - Symbolic level to convert
Returns:
The numeric level identifier
See Also:
LogChannel.getLevel

getLogWriter

public LogWriter getLogWriter(java.lang.String level)
See Also:
LogChannel.getLogWriter#String

getLogWriter

public LogWriter getLogWriter(int level)
See Also:
LogChannel.getLogWriter#int

isEnabled

public boolean isEnabled(int level)
Description copied from interface: LogChannel
Determine if logging is enabled for the specified level. 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.

Specified by:
isEnabled in interface LogChannel
Parameters:
level - Numeric level that is to be checked.
Returns:
true if enabled, false if not enabled.
See Also:
LogChannel.isEnabled

isEnabled

public boolean isEnabled(java.lang.String level)
Description copied from interface: LogChannel
Determine if logging is enabled for the specified level. 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.

Specified by:
isEnabled in interface LogChannel
Parameters:
level - Symbolic level that is to be checked.
Returns:
true if enabled, false if not enabled.
See Also:
LogChannel.isEnabled

write

public void write(int level,
                  java.lang.String msg)
Description copied from interface: LogChannel
Write a string to the log file.

Specified by:
write in interface LogChannel
Parameters:
level - Numeric level the message is associated with.
msg - The message to log.
See Also:
LogChannel.write

write

public void write(java.lang.String level,
                  java.lang.String msg)
Description copied from interface: LogChannel
Write a string to the log file.

Specified by:
write in interface LogChannel
Parameters:
level - Symbolic level the message is associated with.
msg - The message to log.
See Also:
LogChannel.write

write

public void write(int level,
                  java.lang.String msg,
                  java.lang.Throwable throwable)
Description copied from interface: LogChannel
Write a string and exception to the log file.

Specified by:
write in interface LogChannel
Parameters:
level - Numeric level the message is associated with.
msg - The message to log.
throwable - Exception or error to log.
See Also:
LogChannel.write

write

public void write(java.lang.String level,
                  java.lang.String msg,
                  java.lang.Throwable throwable)
Description copied from interface: LogChannel
Write a string and exception to the log file.

Specified by:
write in interface LogChannel
Parameters:
level - Symbolic level the message is associated with.
msg - The message to log.
throwable - Exception or error to log.
See Also:
LogChannel.write

Enhydra 5.1 API