Package com.openhtmltopdf.util

Class XRLog

java.lang.Object

com.openhtmltopdf.util.XRLog

public class XRLog
extends java.lang.Object

Utility class for using the java.util.logging package. Relies on the standard configuration for logging, but gives easier access to the various logs (plumbing.load, .init, .render)

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CASCADE
static java.lang.String	CONFIG
static java.lang.String	CSS_PARSE
static java.lang.String	EXCEPTION
static java.lang.String	GENERAL
static java.lang.String	INIT
private static boolean	initPending
static java.lang.String	JUNIT
static java.lang.String	LAYOUT
static java.lang.String	LOAD
private static java.util.List<java.lang.String>	LOGGER_NAMES
private static XRLogger	loggerImpl
private static java.lang.Boolean	loggingEnabled
static java.lang.String	MATCH
static java.lang.String	RENDER
static java.lang.String	XML_ENTITIES

Constructor Summary

Constructors

Constructor	Description
XRLog()

Method Summary

Modifier and Type	Method	Description
static XRLogger	getLoggerImpl()
private static void	init()
static boolean	isLoggingEnabled()	Whether logging is on or off.
static java.util.List<java.lang.String>	listRegisteredLoggers()	Returns a list of all loggers that will be accessed by XRLog.
static void	log(java.util.logging.Level level, LogMessageId.LogMessageId0Param logMessageId)
static void	log(java.util.logging.Level level, LogMessageId.LogMessageId0Param logMessageId, java.lang.Throwable t)
static void	log(java.util.logging.Level level, LogMessageId.LogMessageId1Param logMessageId, java.lang.Object arg)
static void	log(java.util.logging.Level level, LogMessageId.LogMessageId1Param logMessageId, java.lang.Object arg, java.lang.Throwable throwable)
static void	log(java.util.logging.Level level, LogMessageId.LogMessageId2Param logMessageId, java.lang.Object arg1, java.lang.Object arg2)
static void	log(java.util.logging.Level level, LogMessageId.LogMessageId2Param logMessageId, java.lang.Object arg1, java.lang.Object arg2, java.lang.Throwable throwable)
static void	log(java.util.logging.Level level, LogMessageId.LogMessageId3Param logMessageId, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3)
static void	log(java.util.logging.Level level, LogMessageId.LogMessageId3Param logMessageId, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Throwable throwable)
static void	log(java.util.logging.Level level, LogMessageId.LogMessageId4Param logMessageId, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4)
static void	log(java.util.logging.Level level, LogMessageId.LogMessageId5Param logMessageId, java.lang.Object arg1, java.lang.Object arg2, java.lang.Object arg3, java.lang.Object arg4, java.lang.Object arg5)
private static void	log(java.util.logging.Level level, LogMessageId logMessageId, boolean hasError, java.lang.Object... args)
private static java.lang.String	registerLoggerByName(java.lang.String loggerName)
static void	setLevel(java.lang.String log, java.util.logging.Level level)
static void	setLoggerImpl(XRLogger loggerImpl)
static void	setLoggingEnabled(boolean loggingEnabled)	Turns logging on or off, without affecting logging configuration.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER_NAMES

private static final java.util.List<java.lang.String> LOGGER_NAMES

CONFIG

public static final java.lang.String CONFIG

EXCEPTION

public static final java.lang.String EXCEPTION

GENERAL

public static final java.lang.String GENERAL

INIT

public static final java.lang.String INIT

JUNIT

public static final java.lang.String JUNIT

LOAD

public static final java.lang.String LOAD

MATCH

public static final java.lang.String MATCH

CASCADE

public static final java.lang.String CASCADE

XML_ENTITIES

public static final java.lang.String XML_ENTITIES

CSS_PARSE

public static final java.lang.String CSS_PARSE

LAYOUT

public static final java.lang.String LAYOUT

RENDER

public static final java.lang.String RENDER

initPending

private static volatile boolean initPending

loggerImpl

private static volatile XRLogger loggerImpl

loggingEnabled

private static volatile java.lang.Boolean loggingEnabled

Constructor Detail

XRLog

public XRLog()

Method Detail

registerLoggerByName

private static java.lang.String registerLoggerByName(java.lang.String loggerName)

listRegisteredLoggers

public static java.util.List<java.lang.String> listRegisteredLoggers()

Returns a list of all loggers that will be accessed by XRLog. Each entry is a String with a logger name, which can be used to retrieve the logger using the corresponding Logging API; example name might be "com.openhtmltopdf.render"

Returns:

List of loggers, never null.

log

public static void log(java.util.logging.Level level,
                       LogMessageId.LogMessageId0Param logMessageId)

log

public static void log(java.util.logging.Level level,
                       LogMessageId.LogMessageId0Param logMessageId,
                       java.lang.Throwable t)

log

public static void log(java.util.logging.Level level,
                       LogMessageId.LogMessageId1Param logMessageId,
                       java.lang.Object arg)

log

public static void log(java.util.logging.Level level,
                       LogMessageId.LogMessageId1Param logMessageId,
                       java.lang.Object arg,
                       java.lang.Throwable throwable)

log

public static void log(java.util.logging.Level level,
                       LogMessageId.LogMessageId2Param logMessageId,
                       java.lang.Object arg1,
                       java.lang.Object arg2)

log

public static void log(java.util.logging.Level level,
                       LogMessageId.LogMessageId2Param logMessageId,
                       java.lang.Object arg1,
                       java.lang.Object arg2,
                       java.lang.Throwable throwable)

log

public static void log(java.util.logging.Level level,
                       LogMessageId.LogMessageId3Param logMessageId,
                       java.lang.Object arg1,
                       java.lang.Object arg2,
                       java.lang.Object arg3)

log

public static void log(java.util.logging.Level level,
                       LogMessageId.LogMessageId3Param logMessageId,
                       java.lang.Object arg1,
                       java.lang.Object arg2,
                       java.lang.Object arg3,
                       java.lang.Throwable throwable)

log

public static void log(java.util.logging.Level level,
                       LogMessageId.LogMessageId4Param logMessageId,
                       java.lang.Object arg1,
                       java.lang.Object arg2,
                       java.lang.Object arg3,
                       java.lang.Object arg4)

log

public static void log(java.util.logging.Level level,
                       LogMessageId.LogMessageId5Param logMessageId,
                       java.lang.Object arg1,
                       java.lang.Object arg2,
                       java.lang.Object arg3,
                       java.lang.Object arg4,
                       java.lang.Object arg5)

log

private static void log(java.util.logging.Level level,
                        LogMessageId logMessageId,
                        boolean hasError,
                        java.lang.Object... args)

init

private static void init()

setLevel

public static void setLevel(java.lang.String log,
                            java.util.logging.Level level)

isLoggingEnabled

public static boolean isLoggingEnabled()

Whether logging is on or off.

Returns:

Returns true if logging is enabled, false if not. Corresponds to configuration file property xr.util-logging.loggingEnabled, or to value passed to setLoggingEnabled(bool).

setLoggingEnabled

public static void setLoggingEnabled(boolean loggingEnabled)

Turns logging on or off, without affecting logging configuration.

Parameters:

loggingEnabled - Flag whether logging is enabled or not; if false, all logging calls fail silently. Corresponds to configuration file property xr.util-logging.loggingEnabled

getLoggerImpl

public static XRLogger getLoggerImpl()

setLoggerImpl

public static void setLoggerImpl(XRLogger loggerImpl)