|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.logging.Logger
public class Logger
This is a logging object that allows for all kinds of logging to occur within its appenders
Constructor Summary | |
---|---|
init(any category, [any<numeric> levelMin='0'], [any<numeric> levelMax='4'], [any<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(any<AbstractAppender> newAppender='')
Add a new appender to the list of appenders for this logger |
any<Boolean> |
appenderExists(any name)
Checks to see if a specified appender exists by name |
any<Boolean> |
canDebug()
Can log debug messages |
any<Boolean> |
canError()
Can log error messages |
any<Boolean> |
canFatal()
Can log fatal messages |
any<Boolean> |
canInfo()
Can log info messages |
any<Boolean> |
canLog(any<numeric> level)
Checks wether a log can be made on this Logger using a passed in level |
any<Boolean> |
canWarn()
Can log warn messages |
void |
debug(any message, [any extraInfo=''])
I log a debug message |
void |
error(any message, [any extraInfo=''])
I log an error message |
void |
fatal(any message, [any extraInfo=''])
I log a fatal message |
any |
getAppender(any name)
Get a named appender from this logger class |
any<struct> |
getAppenders()
Get all the registered appenders for this logger |
any |
getCategory()
Get the configured category for this logger |
any<Logger> |
getRootLogger()
Get the root logger |
any<Boolean> |
getlevelMax()
Get the level Max setting |
any<numeric> |
getlevelMin()
Get the level min setting |
any<boolean> |
hasAppenders()
Checks to see if we have registered any appenders yet |
void |
info(any message, [any extraInfo=''])
I log an information message |
void |
logMessage(any message, any<numeric> severity, [any extraInfo=''])
Write an entry into the loggers registered with this LogBox instance |
void |
removeAllAppenders()
Removes all appenders registered |
any<Boolean> |
removeAppender(any name)
Unregister an appender from this Logger |
void |
setCategory(any category)
Set the category for this logger |
void |
setLevelMax(any levelMax)
Set the appender's default levelMax |
void |
setLevelMin(any levelMin)
Set the appender's default levelMin |
void |
setRootLogger(any<Logger> RootLogger)
Set the root logger for this named logger |
void |
warn(any message, [any extraInfo=''])
I log a warning message |
Methods inherited from class WEB-INF.cftags.component |
---|
|
Constructor Detail |
---|
public init(any category, [any<numeric> levelMin='0'], [any<numeric> levelMax='4'], [any<struct> appenders='[runtime expression]'])
category
- The category name to use this logger withlevelMin
- The default log level for this appender, by default it is 0. Optional. ex: LogBox.logLevels.WARNlevelMax
- The default log level for this appender, by default it is 5. Optional. ex: LogBox.logLevels.WARNappenders
- A struct of already created appenders for this category, or blank to use the root logger.Method Detail |
---|
private any $throw(string message, [string detail=''], [string type='Framework'])
message
detail
type
public void addAppender(any<AbstractAppender> newAppender='')
newAppender
- The new appender to add to this logger programmatically.public any<Boolean> appenderExists(any name)
name
- The name of the appender to check if it is registeredpublic any<Boolean> canDebug()
public any<Boolean> canError()
public any<Boolean> canFatal()
public any<Boolean> canInfo()
public any<Boolean> canLog(any<numeric> level)
level
- The level to check if it can be logged in this Loggerpublic any<Boolean> canWarn()
public void debug(any message, [any extraInfo=''])
message
- The message to log.extraInfo
- Extra information to send to the loggers.public void error(any message, [any extraInfo=''])
message
- The message to log.extraInfo
- Extra information to send to the loggers.public void fatal(any message, [any extraInfo=''])
message
- The message to log.extraInfo
- Extra information to send to the loggers.public any getAppender(any name)
name
- The appender's namepublic any<struct> getAppenders()
public any getCategory()
public any<Logger> getRootLogger()
public any<Boolean> getlevelMax()
public any<numeric> getlevelMin()
public any<boolean> hasAppenders()
public void info(any message, [any extraInfo=''])
message
- The message to log.extraInfo
- Extra information to send to the loggers.public void logMessage(any message, any<numeric> severity, [any extraInfo=''])
message
- The message to log.severity
- The severity level to log, if invalid, it will default to INFOextraInfo
- Extra information to send to the loggers.public void removeAllAppenders()
public any<Boolean> removeAppender(any name)
name
- The name of the appender to unregisterpublic void setCategory(any category)
category
public void setLevelMax(any levelMax)
levelMax
public void setLevelMin(any levelMin)
levelMin
public void setRootLogger(any<Logger> RootLogger)
RootLogger
public void warn(any message, [any extraInfo=''])
message
- The message to log.extraInfo
- Extra information to send to the loggers.
|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |