public class LogRecord extends Object implements Serializable
LogRecord
object represents a logging request. It is passed between
the logging framework and individual logging handlers. Client applications
should not modify a LogRecord
object that has been passed into the
logging framework.
The LogRecord
class will infer the source method name and source
class name the first time they are accessed if the client application didn't
specify them explicitly. This automatic inference is based on the analysis of
the call stack and is not guaranteed to be precise. Client applications
should force the initialization of these two fields by calling
getSourceClassName
or getSourceMethodName
if they expect to
use them after passing the LogRecord
object to another thread or
transmitting it over RMI.
Constructor and Description |
---|
LogRecord(Level level,
String msg)
Constructs a
LogRecord object using the supplied the logging
level and message. |
Modifier and Type | Method and Description |
---|---|
Level |
getLevel()
Gets the logging level.
|
String |
getLoggerName()
Gets the name of the logger.
|
String |
getMessage()
Gets the raw message.
|
long |
getMillis()
Gets the time when this event occurred, in milliseconds since 1970.
|
Object[] |
getParameters()
Gets the parameters.
|
ResourceBundle |
getResourceBundle()
Gets the resource bundle used to localize the raw message during
formatting.
|
String |
getResourceBundleName()
Gets the name of the resource bundle.
|
long |
getSequenceNumber()
Gets the sequence number.
|
String |
getSourceClassName()
Gets the name of the class that is the source of this log record.
|
String |
getSourceMethodName()
Gets the name of the method that is the source of this log record.
|
int |
getThreadID()
Gets a unique ID of the thread originating the log record.
|
Throwable |
getThrown()
Gets the
Throwable object associated with this log record. |
void |
setLevel(Level level)
Sets the logging level.
|
void |
setLoggerName(String loggerName)
Sets the name of the logger.
|
void |
setMessage(String message)
Sets the raw message.
|
void |
setMillis(long millis)
Sets the time when this event occurred, in milliseconds since 1970.
|
void |
setParameters(Object[] parameters)
Sets the parameters.
|
void |
setResourceBundle(ResourceBundle resourceBundle)
Sets the resource bundle used to localize the raw message during
formatting.
|
void |
setResourceBundleName(String resourceBundleName)
Sets the name of the resource bundle.
|
void |
setSequenceNumber(long sequenceNumber)
Sets the sequence number.
|
void |
setSourceClassName(String sourceClassName)
Sets the name of the class that is the source of this log record.
|
void |
setSourceMethodName(String sourceMethodName)
Sets the name of the method that is the source of this log record.
|
void |
setThreadID(int threadID)
Sets the ID of the thread originating this log record.
|
void |
setThrown(Throwable thrown)
Sets the
Throwable object associated with this log record. |
public LogRecord(Level level, String msg)
LogRecord
object using the supplied the logging
level and message. The millis property is set to the current time. The
sequence property is set to a new unique value, allocated in increasing
order within the VM. The thread ID is set to a unique value
for the current thread. All other properties are set to null
.level
- the logging level, may not be null
.msg
- the raw message.NullPointerException
- if level
is null
.public Level getLevel()
public void setLevel(Level level)
level
- the level to set.NullPointerException
- if level
is null
.public String getLoggerName()
public void setLoggerName(String loggerName)
loggerName
- the logger name to set.public String getMessage()
null
.public void setMessage(String message)
message
,
then the raw message is replaced with its localized version.message
- the raw message to set, may be null
.public long getMillis()
public void setMillis(long millis)
millis
- the time when this event occurred, in milliseconds since 1970.public Object[] getParameters()
null
if there are no
parameters.public void setParameters(Object[] parameters)
parameters
- the array of parameters to set, may be null
.public ResourceBundle getResourceBundle()
null
if none is
available or the message is not localizable.public void setResourceBundle(ResourceBundle resourceBundle)
resourceBundle
- the resource bundle to set, may be null
.public String getResourceBundleName()
null
if none is
available or the message is not localizable.public void setResourceBundleName(String resourceBundleName)
resourceBundleName
- the name of the resource bundle to set.public long getSequenceNumber()
public void setSequenceNumber(long sequenceNumber)
sequenceNumber
- the sequence number to set.public String getSourceClassName()
null
and is untrusted.null
)public void setSourceClassName(String sourceClassName)
sourceClassName
- the name of the source class of this log record, may be
null
.public String getSourceMethodName()
public void setSourceMethodName(String sourceMethodName)
sourceMethodName
- the name of the source method of this log record, may be
null
.public int getThreadID()
Notice : the ID doesn't necessary map the OS thread ID
public void setThreadID(int threadID)
threadID
- the new ID of the thread originating this log record.public Throwable getThrown()
Throwable
object associated with this log record.Throwable
object associated with this log record.public void setThrown(Throwable thrown)
Throwable
object associated with this log record.thrown
- the new Throwable
object to associate with this log
record.