org.x4juli.global.spi
Interface ExtendedLogRecord

All Superinterfaces:

LogRecord

All Known Implementing Classes:

AbstractExtendedLogRecord

public interface ExtendedLogRecord

extends LogRecord

Interface to specify additional information for a java.util.logging.LogRecord. This is needed i.e. for the PatternFormatter.

Since:

0.5

Author:

Boris Unckel

Method Summary

java.lang.String	getFormattedMessage() Returns the cached formatted message.
java.util.logging.Level	getLevel()
LocationInfo	getLocationInformation() Provide extended information about the caller's location.
java.lang.String	getLoggerName()
java.lang.String	getMessage()
long	getMillis()
java.lang.Object[]	getParameters()
java.util.ResourceBundle	getResourceBundle()
java.lang.String	getResourceBundleName()
long	getSequenceNumber()
java.lang.String	getSourceClassName()
java.lang.String	getSourceMethodName()
long	getStartTime() Provide the time since start of logging.
int	getThreadID()
ThrowableInformation	getThrowableInformation() Provide extended information about the attached throwable.
java.lang.Throwable	getThrown()
void	setFormattedMessage(java.lang.String formattedMessage) Setup the cache for the formatted message.
void	setLevel(java.util.logging.Level level)
void	setLoggerName(java.lang.String name)
void	setMessage(java.lang.String message)
void	setMillis(long millis)
void	setParameters(java.lang.Object[] parameters)
void	setResourceBundle(java.util.ResourceBundle bundle)
void	setResourceBundleName(java.lang.String name)
void	setSequenceNumber(long seq)
void	setSourceClassName(java.lang.String sourceClassName)
void	setSourceMethodName(java.lang.String sourceMethodName)
void	setThreadID(int threadID)
void	setThrown(java.lang.Throwable thrown)

Method Detail

getThrowableInformation

public ThrowableInformation getThrowableInformation()

Provide extended information about the attached throwable. Returns null, if there was no throwable in the LogRecord attached.

Returns:

internal representation of Juli for the Throwable

Since:

0.5

getLocationInformation

public LocationInfo getLocationInformation()

Provide extended information about the caller's location. These information should respect the Logger class or any subclasses. (Make use of the correct, corresponding FQCN).

Returns:

internal representation of Juli for the Caller Location

Since:

0.5

getStartTime

public long getStartTime()

Provide the time since start of logging.

Returns:

the start time of Juli, determined by the first use of the implementor

Since:

0.5

setFormattedMessage

public void setFormattedMessage(java.lang.String formattedMessage)

Setup the cache for the formatted message.

Parameters:

formattedMessage - current state of the formatted message.

getFormattedMessage

public java.lang.String getFormattedMessage()

Returns the cached formatted message.

Returns:

the cached formatted message, if cache is empty, returns the message.

getLoggerName

public java.lang.String getLoggerName()

Since:

0.5

See Also:

LogRecord.getLoggerName()

setLoggerName

public void setLoggerName(java.lang.String name)

Since:

0.5

See Also:

LogRecord.setLoggerName(java.lang.String)

getResourceBundle

public java.util.ResourceBundle getResourceBundle()

Since:

0.5

See Also:

LogRecord.getResourceBundle()

setResourceBundle

public void setResourceBundle(java.util.ResourceBundle bundle)

Since:

0.5

See Also:

LogRecord.setResourceBundle(java.util.ResourceBundle)

getResourceBundleName

public java.lang.String getResourceBundleName()

Since:

0.5

See Also:

LogRecord.getResourceBundleName()

setResourceBundleName

public void setResourceBundleName(java.lang.String name)

Since:

0.5

See Also:

LogRecord.setResourceBundleName(java.lang.String)

getLevel

public java.util.logging.Level getLevel()

Since:

0.5

See Also:

LogRecord.getLevel()

setLevel

public void setLevel(java.util.logging.Level level)

Since:

0.5

See Also:

LogRecord.setLevel(java.util.logging.Level)

getSequenceNumber

public long getSequenceNumber()

Since:

0.5

See Also:

LogRecord.getSequenceNumber()

setSequenceNumber

public void setSequenceNumber(long seq)

Since:

0.5

See Also:

LogRecord.setSequenceNumber(long)

getSourceClassName

public java.lang.String getSourceClassName()

Since:

0.5

See Also:

LogRecord.getSourceClassName()

setSourceClassName

public void setSourceClassName(java.lang.String sourceClassName)

Since:

0.5

See Also:

LogRecord.setSourceClassName(java.lang.String)

getSourceMethodName

public java.lang.String getSourceMethodName()

Since:

0.5

See Also:

LogRecord.getSourceMethodName()

setSourceMethodName

public void setSourceMethodName(java.lang.String sourceMethodName)

Since:

0.5

See Also:

LogRecord.setSourceMethodName(java.lang.String)

getMessage

public java.lang.String getMessage()

Since:

0.5

See Also:

LogRecord.getMessage()

setMessage

public void setMessage(java.lang.String message)

Since:

0.5

See Also:

LogRecord.setMessage(java.lang.String)

getParameters

public java.lang.Object[] getParameters()

Since:

0.5

See Also:

LogRecord.getParameters()

setParameters

public void setParameters(java.lang.Object[] parameters)

Since:

0.5

See Also:

LogRecord.setParameters(java.lang.Object[])

getThreadID

public int getThreadID()

Since:

0.5

See Also:

LogRecord.getThreadID()

setThreadID

public void setThreadID(int threadID)

Since:

0.5

See Also:

LogRecord.setThreadID(int)

getMillis

public long getMillis()

Since:

0.5

See Also:

LogRecord.getMillis()

setMillis

public void setMillis(long millis)

Since:

0.5

See Also:

LogRecord.setMillis(long)

getThrown

public java.lang.Throwable getThrown()

Since:

0.5

See Also:

LogRecord.getThrown()

setThrown

public void setThrown(java.lang.Throwable thrown)

Since:

0.5

See Also:

LogRecord.setThrown(java.lang.Throwable)