fm.liveswitch.ILog Interface Reference

ILog interface for loggers. More...

Public Member Functions

abstract void debug (String message)
 Writes a debug message to the log. More...
 
abstract void debug (String message, java.lang.Exception ex)
 Writes a debug message with exception to the log. More...
 
abstract void debug (String scope, String message)
 Writes a debug message to the log. More...
 
abstract void debug (String scope, String message, java.lang.Exception ex)
 Writes a debug message with exception to the log. More...
 
abstract void error (String message)
 Writes a error message to the log. More...
 
abstract void error (String message, java.lang.Exception ex)
 Writes a error message with exception to the log. More...
 
abstract void error (String scope, String message)
 Writes a error message to the log. More...
 
abstract void error (String scope, String message, java.lang.Exception ex)
 Writes a error message with exception to the log. More...
 
abstract void fatal (String message)
 Writes a fatal message to the log. More...
 
abstract void fatal (String message, java.lang.Exception ex)
 Writes a fatal message with exception to the log. More...
 
abstract void fatal (String scope, String message)
 Writes a fatal message to the log. More...
 
abstract void fatal (String scope, String message, java.lang.Exception ex)
 Writes a fatal message with exception to the log. More...
 
abstract void flush ()
 Ensures that all logs are written out. More...
 
abstract boolean getIsDebugEnabled ()
 Gets if the debug log level is enabled. More...
 
abstract boolean getIsErrorEnabled ()
 Gets if the error log level is enabled. More...
 
abstract boolean getIsFatalEnabled ()
 Gets if the fatal log level is enabled. More...
 
abstract boolean getIsInfoEnabled ()
 Gets if the info log level is enabled. More...
 
abstract boolean getIsVerboseEnabled ()
 Gets if the verbose log level is enabled. More...
 
abstract boolean getIsWarnEnabled ()
 Gets if the warn log level is enabled. More...
 
abstract String getTag ()
 Gets the tag of the logger. More...
 
abstract void info (String message)
 Writes a info message to the log. More...
 
abstract void info (String message, java.lang.Exception ex)
 Writes an info message with exception to the log. More...
 
abstract void info (String scope, String message)
 Writes a info message to the log. More...
 
abstract void info (String scope, String message, java.lang.Exception ex)
 Writes an info message with exception to the log. More...
 
abstract boolean isLogEnabled (fm.liveswitch.LogLevel level)
 Returns true if the passed log level is enabled on this logger. More...
 
abstract void log (fm.liveswitch.LogEvent logEvent)
 Writes a log event to the log. More...
 
abstract void log (String message)
 Writes a generic message to the log. More...
 
abstract void log (String scope, String message)
 Writes a generic message to the log. More...
 
abstract void verbose (String message)
 Writes a verbose message to the log. More...
 
abstract void verbose (String message, java.lang.Exception ex)
 Writes a verbose message with exception to the log. More...
 
abstract void verbose (String scope, String message)
 Writes a verbose message to the log. More...
 
abstract void verbose (String scope, String message, java.lang.Exception ex)
 Writes a verbose message with exception to the log. More...
 
abstract void warn (String message)
 Writes a warn message to the log. More...
 
abstract void warn (String message, java.lang.Exception ex)
 Writes a warn message with exception to the log. More...
 
abstract void warn (String scope, String message)
 Writes a warn message to the log. More...
 
abstract void warn (String scope, String message, java.lang.Exception ex)
 Writes a warn message with exception to the log. More...
 

Detailed Description

ILog interface for loggers.

Member Function Documentation

◆ debug() [1/4]

abstract void fm.liveswitch.ILog.debug ( String  message)
abstract

Writes a debug message to the log.

Parameters
messageThe log message.

◆ debug() [2/4]

abstract void fm.liveswitch.ILog.debug ( String  message,
java.lang.Exception  ex 
)
abstract

Writes a debug message with exception to the log.

Parameters
messageThe log message.
exThe exception.

◆ debug() [3/4]

abstract void fm.liveswitch.ILog.debug ( String  scope,
String  message 
)
abstract

Writes a debug message to the log.

Parameters
scopeThe scope of this log message.
messageThe log message.

◆ debug() [4/4]

abstract void fm.liveswitch.ILog.debug ( String  scope,
String  message,
java.lang.Exception  ex 
)
abstract

Writes a debug message with exception to the log.

Parameters
scopeThe scope of this log message.
messageThe log message.
exThe exception.

◆ error() [1/4]

abstract void fm.liveswitch.ILog.error ( String  message)
abstract

Writes a error message to the log.

Parameters
messageThe log message.

◆ error() [2/4]

abstract void fm.liveswitch.ILog.error ( String  message,
java.lang.Exception  ex 
)
abstract

Writes a error message with exception to the log.

Parameters
messageThe log message.
exThe exception.

◆ error() [3/4]

abstract void fm.liveswitch.ILog.error ( String  scope,
String  message 
)
abstract

Writes a error message to the log.

Parameters
scopeThe scope of this log message.
messageThe log message.

◆ error() [4/4]

abstract void fm.liveswitch.ILog.error ( String  scope,
String  message,
java.lang.Exception  ex 
)
abstract

Writes a error message with exception to the log.

Parameters
scopeThe scope of this log message.
messageThe log message.
exThe exception.

◆ fatal() [1/4]

abstract void fm.liveswitch.ILog.fatal ( String  message)
abstract

Writes a fatal message to the log.

Parameters
messageThe log message.

◆ fatal() [2/4]

abstract void fm.liveswitch.ILog.fatal ( String  message,
java.lang.Exception  ex 
)
abstract

Writes a fatal message with exception to the log.

Parameters
messageThe log message.
exThe exception.

◆ fatal() [3/4]

abstract void fm.liveswitch.ILog.fatal ( String  scope,
String  message 
)
abstract

Writes a fatal message to the log.

Parameters
scopeThe scope of this log message.
messageThe log message.

◆ fatal() [4/4]

abstract void fm.liveswitch.ILog.fatal ( String  scope,
String  message,
java.lang.Exception  ex 
)
abstract

Writes a fatal message with exception to the log.

Parameters
scopeThe scope of this log message.
messageThe log message.
exThe exception.

◆ flush()

abstract void fm.liveswitch.ILog.flush ( )
abstract

Ensures that all logs are written out.

◆ getIsDebugEnabled()

abstract boolean fm.liveswitch.ILog.getIsDebugEnabled ( )
abstract

Gets if the debug log level is enabled.

◆ getIsErrorEnabled()

abstract boolean fm.liveswitch.ILog.getIsErrorEnabled ( )
abstract

Gets if the error log level is enabled.

◆ getIsFatalEnabled()

abstract boolean fm.liveswitch.ILog.getIsFatalEnabled ( )
abstract

Gets if the fatal log level is enabled.

◆ getIsInfoEnabled()

abstract boolean fm.liveswitch.ILog.getIsInfoEnabled ( )
abstract

Gets if the info log level is enabled.

◆ getIsVerboseEnabled()

abstract boolean fm.liveswitch.ILog.getIsVerboseEnabled ( )
abstract

Gets if the verbose log level is enabled.

◆ getIsWarnEnabled()

abstract boolean fm.liveswitch.ILog.getIsWarnEnabled ( )
abstract

Gets if the warn log level is enabled.

◆ getTag()

abstract String fm.liveswitch.ILog.getTag ( )
abstract

Gets the tag of the logger.

◆ info() [1/4]

abstract void fm.liveswitch.ILog.info ( String  message)
abstract

Writes a info message to the log.

Parameters
messageThe log message.

◆ info() [2/4]

abstract void fm.liveswitch.ILog.info ( String  message,
java.lang.Exception  ex 
)
abstract

Writes an info message with exception to the log.

Parameters
messageThe log message.
exThe exception.

◆ info() [3/4]

abstract void fm.liveswitch.ILog.info ( String  scope,
String  message 
)
abstract

Writes a info message to the log.

Parameters
scopeThe scope of this log message.
messageThe log message.

◆ info() [4/4]

abstract void fm.liveswitch.ILog.info ( String  scope,
String  message,
java.lang.Exception  ex 
)
abstract

Writes an info message with exception to the log.

Parameters
scopeThe scope of this log message.
messageThe log message.
exThe exception.

◆ isLogEnabled()

abstract boolean fm.liveswitch.ILog.isLogEnabled ( fm.liveswitch.LogLevel  level)
abstract

Returns true if the passed log level is enabled on this logger.

Parameters
levelLog level to check.

◆ log() [1/3]

abstract void fm.liveswitch.ILog.log ( fm.liveswitch.LogEvent  logEvent)
abstract

Writes a log event to the log.

Parameters
logEventThe log event.

◆ log() [2/3]

abstract void fm.liveswitch.ILog.log ( String  message)
abstract

Writes a generic message to the log.

Parameters
messageThe log message.

◆ log() [3/3]

abstract void fm.liveswitch.ILog.log ( String  scope,
String  message 
)
abstract

Writes a generic message to the log.

Parameters
scopeThe scope of this log message.
messageThe log message.

◆ verbose() [1/4]

abstract void fm.liveswitch.ILog.verbose ( String  message)
abstract

Writes a verbose message to the log.

Parameters
messageThe log message.

◆ verbose() [2/4]

abstract void fm.liveswitch.ILog.verbose ( String  message,
java.lang.Exception  ex 
)
abstract

Writes a verbose message with exception to the log.

Parameters
messageThe log message.
exThe exception.

◆ verbose() [3/4]

abstract void fm.liveswitch.ILog.verbose ( String  scope,
String  message 
)
abstract

Writes a verbose message to the log.

Parameters
scopeThe scope of this log message.
messageThe log message.

◆ verbose() [4/4]

abstract void fm.liveswitch.ILog.verbose ( String  scope,
String  message,
java.lang.Exception  ex 
)
abstract

Writes a verbose message with exception to the log.

Parameters
scopeThe scope of this log message.
messageThe log message.
exThe exception.

◆ warn() [1/4]

abstract void fm.liveswitch.ILog.warn ( String  message)
abstract

Writes a warn message to the log.

Parameters
messageThe log message.

◆ warn() [2/4]

abstract void fm.liveswitch.ILog.warn ( String  message,
java.lang.Exception  ex 
)
abstract

Writes a warn message with exception to the log.

Parameters
messageThe log message.
exThe exception.

◆ warn() [3/4]

abstract void fm.liveswitch.ILog.warn ( String  scope,
String  message 
)
abstract

Writes a warn message to the log.

Parameters
scopeThe scope of this log message.
messageThe log message.

◆ warn() [4/4]

abstract void fm.liveswitch.ILog.warn ( String  scope,
String  message,
java.lang.Exception  ex 
)
abstract

Writes a warn message with exception to the log.

Parameters
scopeThe scope of this log message.
messageThe log message.
exThe exception.