EAF 7.4 API

com.lutris.logging
Interface LogChannel


public interface LogChannel

Interface of a channel associated with a logging facility. All messages for the facility are written using a channel.

Author:
Mark Diekhans
See Also:
Logger, LogWriter

Method Summary
 int getLevel(java.lang.String level)
          Convert a symbolic level to an integer identifier.
 LogWriter getLogWriter(int level)
          Create a LogWrite associated with a particular level.
 LogWriter getLogWriter(java.lang.String level)
          Create a LogWrite associated with a particular 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.
 

Method Detail

isEnabled

boolean isEnabled(int level)
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.

Parameters:
level - Numeric level that is to be checked.
Returns:
true if enabled, false if not enabled.

isEnabled

boolean isEnabled(java.lang.String level)
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.

Parameters:
level - Symbolic level that is to be checked.
Returns:
true if enabled, false if not enabled.

getLevel

int getLevel(java.lang.String level)
Convert a symbolic level to an integer identifier.

Parameters:
level - Symbolic level to convert
Returns:
The numeric level identifier

getLogWriter

LogWriter getLogWriter(java.lang.String level)
Create a LogWrite associated with a particular level. This is often an easier object to use than a LogChannel if limited levels are needed.

Parameters:
level - Symbolic level that is to be checked.
Returns:
A log writer object.

getLogWriter

LogWriter getLogWriter(int level)
Create a LogWrite associated with a particular level. This is often an easier object to use than a LogChannel if limited levels are needed.

Parameters:
level - Numeric level that is to be checked.
Returns:
A log writer object.

write

void write(int level,
           java.lang.String msg)
Write a string to the log file.

Parameters:
level - Numeric level the message is associated with.
msg - The message to log.

write

void write(java.lang.String level,
           java.lang.String msg)
Write a string to the log file.

Parameters:
level - Symbolic level the message is associated with.
msg - The message to log.

write

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

Parameters:
level - Numeric level the message is associated with.
msg - The message to log.
throwable - Exception or error to log.

write

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

Parameters:
level - Symbolic level the message is associated with.
msg - The message to log.
throwable - Exception or error to log.

EAF 7.4 API