Callable

Class

ColdBox Platform Version 2.6.4

FRAMES

coldbox.system.logging
Class Logger

WEB-INF.cftags.component
        coldbox.system.logging.Logger

public class Logger
extends WEB-INF.cftags.component
extends WEB-INF.cftags.component

This is a logging object that allows for all kinds of logging to occur within its appenders

Constructor Summary
`init(string category, [numeric levelMin='0'], [numeric levelMax='4'], [struct appenders='[runtime expression]'])` Create a new logger object

Method Summary
`private any`	`$throw(string message, [string detail=''], [string type='Framework'])` Facade for cfthrow
`void`	`addAppender(AbstractAppender newAppender='')` Add a new appender to the list of appenders for this logger
`boolean`	`appenderExists(string name)` Checks to see if a specified appender exists by name
`boolean`	`canLog(numeric level)` Checks wether a log can be made on this Logger using a passed in level
`void`	`debug(string message, [any extraInfo=''])` I log a debug message
`void`	`error(string message, [any extraInfo=''])` I log an error message
`void`	`fatal(string message, [any extraInfo=''])` I log a fatal message
`any`	`getAppender(string name)` Get a named appender from this logger class
`struct`	`getAppenders()` Get all the registered appenders for this logger
`string`	`getCategory()` Get the configured category for this logger
`Logger`	`getRootLogger()` Get the root logger
`numeric`	`getlevelMax()` Get the level Max setting
`numeric`	`getlevelMin()` Get the level min setting
`boolean`	`hasAppenders()` Checks to see if we have registered any appenders yet
`void`	`info(string message, [any extraInfo=''])` I log an information message
`void`	`logMessage(string message, numeric severity, [any extraInfo=''])` Write an entry into the loggers registered with this LogBox instance
`void`	`removeAllAppenders()` Removes all appenders registered
`boolean`	`removeAppender(string name)` Unregister an appender from this Logger
`void`	`setCategory(string category)` Set the category for this logger
`void`	`setLevelMax(numeric levelMax)` Set the appender's default levelMax
`void`	`setLevelMin(numeric levelMin)` Set the appender's default levelMin
`void`	`setRootLogger(Logger RootLogger)` Set the root logger for this named logger
`void`	`warn(string message, [any extraInfo=''])` I log a warning message

Methods inherited from class WEB-INF.cftags.component

Constructor Detail

init

public init(string category, [numeric levelMin='0'], [numeric levelMax='4'], [struct appenders='[runtime expression]'])

Create a new logger object.

Parameters:: category - The category name to use this logger with; levelMin - The default log level for this appender, by default it is 0. Optional. ex: LogBox.logLevels.WARN; levelMax - The default log level for this appender, by default it is 5. Optional. ex: LogBox.logLevels.WARN; appenders - A map of already created appenders for this category, or blank to use the root logger.

Method Detail

$throw

private any $throw(string message, [string detail=''], [string type='Framework'])

Facade for cfthrow

addAppender

public void addAppender(AbstractAppender newAppender='')

Add a new appender to the list of appenders for this logger. If the appender already exists, then it will not be added.

appenderExists

public boolean appenderExists(string name)

Checks to see if a specified appender exists by name.

canLog

public boolean canLog(numeric level)

Checks wether a log can be made on this Logger using a passed in level

debug

public void debug(string message, [any extraInfo=''])

I log a debug message.

error

public void error(string message, [any extraInfo=''])

I log an error message.

fatal

public void fatal(string message, [any extraInfo=''])

I log a fatal message.

getAppender

public any getAppender(string name)

Get a named appender from this logger class. If the appender does not exists, it will throw an exception.

getAppenders

public struct getAppenders()

Get all the registered appenders for this logger.

getCategory

public string getCategory()

Get the configured category for this logger

getRootLogger

public Logger getRootLogger()

Get the root logger

getlevelMax

public numeric getlevelMax()

Get the level Max setting

getlevelMin

public numeric getlevelMin()

Get the level min setting

hasAppenders

public boolean hasAppenders()

Checks to see if we have registered any appenders yet

info

public void info(string message, [any extraInfo=''])

I log an information message.

logMessage

public void logMessage(string message, numeric severity, [any extraInfo=''])

Write an entry into the loggers registered with this LogBox instance.

removeAllAppenders

public void removeAllAppenders()

Removes all appenders registered

removeAppender

public boolean removeAppender(string name)

Unregister an appender from this Logger. True if successful or false otherwise.

setCategory

public void setCategory(string category)

Set the category for this logger

setLevelMax

public void setLevelMax(numeric levelMax)

Set the appender's default levelMax

setLevelMin

public void setLevelMin(numeric levelMin)

Set the appender's default levelMin

setRootLogger

public void setRootLogger(Logger RootLogger)

Set the root logger for this named logger.

warn

public void warn(string message, [any extraInfo=''])

I log a warning message.

Overview

Package