Package org.apache.logging.log4j.simple

Class SimpleLogger

java.lang.Object

org.apache.logging.log4j.spi.AbstractLogger

org.apache.logging.log4j.simple.SimpleLogger

All Implemented Interfaces:

Serializable, Logger, ExtendedLogger, LocationAwareLogger

public class SimpleLogger
extends AbstractLogger

This is the default logger that is used when no suitable logging implementation is available.

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.apache.logging.log4j.spi.AbstractLogger

CATCHING_MARKER, DEFAULT_FLOW_MESSAGE_FACTORY_CLASS, DEFAULT_MESSAGE_FACTORY_CLASS, ENTRY_MARKER, EXCEPTION_MARKER, EXIT_MARKER, FLOW_MARKER, name, THROWING_MARKER

Constructor Summary

Constructors

Constructor	Description
SimpleLogger(String name, Level defaultLevel, boolean showLogName, boolean showShortLogName, boolean showDateTime, boolean showContextMap, String dateTimeFormat, MessageFactory messageFactory, PropertiesUtil props, PrintStream stream)

Method Summary

Modifier and Type	Method	Description
Level	getLevel()	Gets the Level associated with the Logger.
boolean	isEnabled(Level testLevel, Marker marker, CharSequence msg, Throwable t)	Tests if logging is enabled.
boolean	isEnabled(Level testLevel, Marker marker, Object msg, Throwable t)	Tests if logging is enabled.
boolean	isEnabled(Level testLevel, Marker marker, String msg)	Tests if logging is enabled.
boolean	isEnabled(Level testLevel, Marker marker, String message, Object p0)	Tests if logging is enabled.
boolean	isEnabled(Level testLevel, Marker marker, String msg, Object... p1)	Tests if logging is enabled.
boolean	isEnabled(Level testLevel, Marker marker, String message, Object p0, Object p1)	Tests if logging is enabled.
boolean	isEnabled(Level testLevel, Marker marker, String message, Object p0, Object p1, Object p2)	Tests if logging is enabled.
boolean	isEnabled(Level testLevel, Marker marker, String message, Object p0, Object p1, Object p2, Object p3)	Tests if logging is enabled.
boolean	isEnabled(Level testLevel, Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4)	Tests if logging is enabled.
boolean	isEnabled(Level testLevel, Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5)	Tests if logging is enabled.
boolean	isEnabled(Level testLevel, Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6)	Determines if logging is enabled.
boolean	isEnabled(Level testLevel, Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7)	Tests if logging is enabled.
boolean	isEnabled(Level testLevel, Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7, Object p8)	Tests if logging is enabled.
boolean	isEnabled(Level testLevel, Marker marker, String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7, Object p8, Object p9)	Tests if logging is enabled.
boolean	isEnabled(Level testLevel, Marker marker, String msg, Throwable t)	Tests if logging is enabled.
boolean	isEnabled(Level testLevel, Marker marker, Message msg, Throwable t)	Tests if logging is enabled.
void	logMessage(String fqcn, Level mgsLevel, Marker marker, Message msg, Throwable throwable)	Logs a message at the specified level.
void	setLevel(Level level)
void	setStream(PrintStream stream)

Methods inherited from class org.apache.logging.log4j.spi.AbstractLogger

always, atDebug, atError, atFatal, atInfo, atLevel, atTrace, atWarn, catching, catching, catching, catchingMsg, checkMessageFactory, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, debug, enter, enter, enter, enter, enter, entry, entry, entry, entryMsg, entryMsg, entryMsg, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, error, exit, exit, exit, exit, exitMsg, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, fatal, getFlowMessageFactory, getLogBuilder, getMessageFactory, getName, getRecursionDepth, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, info, isDebugEnabled, isDebugEnabled, isEnabled, isEnabled, isErrorEnabled, isErrorEnabled, isFatalEnabled, isFatalEnabled, isInfoEnabled, isInfoEnabled, isTraceEnabled, isTraceEnabled, isWarnEnabled, isWarnEnabled, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, log, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logIfEnabled, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, logMessage, printf, printf, requiresLocation, throwing, throwing, throwing, throwingMsg, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, trace, traceEntry, traceEntry, traceEntry, traceEntry, traceEntry, traceExit, traceExit, traceExit, traceExit, traceExit, traceExit, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SimpleLogger

public SimpleLogger(String name,
 Level defaultLevel,
 boolean showLogName,
 boolean showShortLogName,
 boolean showDateTime,
 boolean showContextMap,
 String dateTimeFormat,
 MessageFactory messageFactory,
 PropertiesUtil props,
 PrintStream stream)

Method Details

getLevel

public Level getLevel()

Description copied from interface: Logger

Gets the Level associated with the Logger.

Returns:

the Level associate with the Logger.

isEnabled

public boolean isEnabled(Level testLevel,
 Marker marker,
 Message msg,
 Throwable t)

Description copied from interface: ExtendedLogger

Tests if logging is enabled.

Parameters:

testLevel - The logging Level to check.

marker - A Marker or null.

msg - The Message.

t - A Throwable.

Returns:

True if logging is enabled, false otherwise.

isEnabled

public boolean isEnabled(Level testLevel,
 Marker marker,
 CharSequence msg,
 Throwable t)

Description copied from interface: ExtendedLogger

Tests if logging is enabled.

Parameters:

testLevel - The logging Level to check.

marker - A Marker or null.

msg - The message.

t - A Throwable.

Returns:

True if logging is enabled, false otherwise.

isEnabled

public boolean isEnabled(Level testLevel,
 Marker marker,
 Object msg,
 Throwable t)

Description copied from interface: ExtendedLogger

Tests if logging is enabled.

Parameters:

testLevel - The logging Level to check.

marker - A Marker or null.

msg - The message.

t - A Throwable.

Returns:

True if logging is enabled, false otherwise.

isEnabled

public boolean isEnabled(Level testLevel,
 Marker marker,
 String msg)

Description copied from interface: ExtendedLogger

Tests if logging is enabled.

Parameters:

testLevel - The logging Level to check.

marker - A Marker or null.

msg - The message.

Returns:

True if logging is enabled, false otherwise.

isEnabled

public boolean isEnabled(Level testLevel,
 Marker marker,
 String msg,
 Object... p1)

Description copied from interface: ExtendedLogger

Tests if logging is enabled.

Parameters:

testLevel - The logging Level to check.

marker - A Marker or null.

msg - The message.

p1 - The parameters.

Returns:

True if logging is enabled, false otherwise.

isEnabled

public boolean isEnabled(Level testLevel,
 Marker marker,
 String message,
 Object p0)

Description copied from interface: ExtendedLogger

Tests if logging is enabled.

Parameters:

testLevel - The logging Level to check.

marker - A Marker or null.

message - The message.

p0 - the message parameters

Returns:

True if logging is enabled, false otherwise.

isEnabled

public boolean isEnabled(Level testLevel,
 Marker marker,
 String message,
 Object p0,
 Object p1)

Description copied from interface: ExtendedLogger

Tests if logging is enabled.

Parameters:

testLevel - The logging Level to check.

marker - A Marker or null.

message - The message.

p0 - the message parameters

p1 - the message parameters

Returns:

True if logging is enabled, false otherwise.

isEnabled

public boolean isEnabled(Level testLevel,
 Marker marker,
 String message,
 Object p0,
 Object p1,
 Object p2)

Description copied from interface: ExtendedLogger

Tests if logging is enabled.

Parameters:

testLevel - The logging Level to check.

marker - A Marker or null.

message - The message.

p0 - the message parameters

p1 - the message parameters

p2 - the message parameters

Returns:

True if logging is enabled, false otherwise.

isEnabled

public boolean isEnabled(Level testLevel,
 Marker marker,
 String message,
 Object p0,
 Object p1,
 Object p2,
 Object p3)

Description copied from interface: ExtendedLogger

Tests if logging is enabled.

Parameters:

testLevel - The logging Level to check.

marker - A Marker or null.

message - The message.

p0 - the message parameters

p1 - the message parameters

p2 - the message parameters

p3 - the message parameters

Returns:

True if logging is enabled, false otherwise.

isEnabled

public boolean isEnabled(Level testLevel,
 Marker marker,
 String message,
 Object p0,
 Object p1,
 Object p2,
 Object p3,
 Object p4)

Description copied from interface: ExtendedLogger

Tests if logging is enabled.

Parameters:

testLevel - The logging Level to check.

marker - A Marker or null.

message - The message.

p0 - the message parameters

p1 - the message parameters

p2 - the message parameters

p3 - the message parameters

p4 - the message parameters

Returns:

True if logging is enabled, false otherwise.

isEnabled

public boolean isEnabled(Level testLevel,
 Marker marker,
 String message,
 Object p0,
 Object p1,
 Object p2,
 Object p3,
 Object p4,
 Object p5)

Description copied from interface: ExtendedLogger

Tests if logging is enabled.

Parameters:

testLevel - The logging Level to check.

marker - A Marker or null.

message - The message.

p0 - the message parameters

p1 - the message parameters

p2 - the message parameters

p3 - the message parameters

p4 - the message parameters

p5 - the message parameters

Returns:

True if logging is enabled, false otherwise.

isEnabled

public boolean isEnabled(Level testLevel,
 Marker marker,
 String message,
 Object p0,
 Object p1,
 Object p2,
 Object p3,
 Object p4,
 Object p5,
 Object p6)

Description copied from interface: ExtendedLogger

Determines if logging is enabled.

Parameters:

testLevel - The logging Level to check.

marker - A Marker or null.

message - The message.

p0 - the message parameters

p1 - the message parameters

p2 - the message parameters

p3 - the message parameters

p4 - the message parameters

p5 - the message parameters

p6 - the message parameters

Returns:

True if logging is enabled, false otherwise.

isEnabled

public boolean isEnabled(Level testLevel,
 Marker marker,
 String message,
 Object p0,
 Object p1,
 Object p2,
 Object p3,
 Object p4,
 Object p5,
 Object p6,
 Object p7)

Description copied from interface: ExtendedLogger

Tests if logging is enabled.

Parameters:

testLevel - The logging Level to check.

marker - A Marker or null.

message - The message.

p0 - the message parameters

p1 - the message parameters

p2 - the message parameters

p3 - the message parameters

p4 - the message parameters

p5 - the message parameters

p6 - the message parameters

p7 - the message parameters

Returns:

True if logging is enabled, false otherwise.

isEnabled

public boolean isEnabled(Level testLevel,
 Marker marker,
 String message,
 Object p0,
 Object p1,
 Object p2,
 Object p3,
 Object p4,
 Object p5,
 Object p6,
 Object p7,
 Object p8)

Description copied from interface: ExtendedLogger

Tests if logging is enabled.

Parameters:

testLevel - The logging Level to check.

marker - A Marker or null.

message - The message.

p0 - the message parameters

p1 - the message parameters

p2 - the message parameters

p3 - the message parameters

p4 - the message parameters

p5 - the message parameters

p6 - the message parameters

p7 - the message parameters

p8 - the message parameters

Returns:

True if logging is enabled, false otherwise.

isEnabled

public boolean isEnabled(Level testLevel,
 Marker marker,
 String message,
 Object p0,
 Object p1,
 Object p2,
 Object p3,
 Object p4,
 Object p5,
 Object p6,
 Object p7,
 Object p8,
 Object p9)

Description copied from interface: ExtendedLogger

Tests if logging is enabled.

Parameters:

testLevel - The logging Level to check.

marker - A Marker or null.

message - The message.

p0 - the message parameters

p1 - the message parameters

p2 - the message parameters

p3 - the message parameters

p4 - the message parameters

p5 - the message parameters

p6 - the message parameters

p7 - the message parameters

p8 - the message parameters

p9 - the message parameters

Returns:

True if logging is enabled, false otherwise.

isEnabled

public boolean isEnabled(Level testLevel,
 Marker marker,
 String msg,
 Throwable t)

Description copied from interface: ExtendedLogger

Tests if logging is enabled.

Parameters:

testLevel - The logging Level to check.

marker - A Marker or null.

msg - The message.

t - the exception to log, including its stack trace.

Returns:

True if logging is enabled, false otherwise.

logMessage

public void logMessage(String fqcn,
 Level mgsLevel,
 Marker marker,
 Message msg,
 Throwable throwable)

Description copied from interface: ExtendedLogger

Logs a message at the specified level. It is the responsibility of the caller to ensure the specified level is enabled.

Parameters:

fqcn - The fully qualified class name of the logger entry point, used to determine the caller class and method when location information needs to be logged.

mgsLevel - The logging Level to check.

marker - A Marker or null.

msg - The Message.

throwable - the exception to log, including its stack trace.

setLevel

public void setLevel(Level level)

setStream

public void setStream(PrintStream stream)