Serializable
public class LogRecord extends Object implements Serializable
When a LogRecord is passed into the logging framework it logically belongs to the framework and should no longer be used or updated by the client application.
Note that if the client application has not specified an explicit source method name and source class name, then the LogRecord class will infer them automatically when they are first accessed (due to a call on getSourceMethodName or getSourceClassName) by analyzing the call stack. Therefore, if a logging Handler wants to pass off a LogRecord to another thread, or to transmit it over RMI, and if it wishes to subsequently obtain method name or class name information it should call one of getSourceClassName or getSourceMethodName to force the values to be filled in.
Serialization notes:
Constructor | Description |
---|---|
LogRecord |
Construct a LogRecord with the given level and message values. |
Modifier and Type | Method | Description |
---|---|---|
Instant |
getInstant() |
Gets the instant that the event occurred. |
Level |
getLevel() |
Get the logging message level, for example Level.SEVERE. |
String |
getLoggerName() |
Get the source Logger's name. |
long |
getLongThreadID() |
Get a thread identifier for the thread where message originated |
String |
getMessage() |
Get the "raw" log message, before localization or formatting. |
long |
getMillis() |
Get truncated event time in milliseconds since 1970. |
Object[] |
getParameters() |
Get the parameters to the log message. |
ResourceBundle |
getResourceBundle() |
Get the localization resource bundle |
String |
getResourceBundleName() |
Get the localization resource bundle name |
long |
getSequenceNumber() |
Get the sequence number. |
String |
getSourceClassName() |
Get the name of the class that (allegedly) issued the logging request. |
String |
getSourceMethodName() |
Get the name of the method that (allegedly) issued the logging request. |
int |
getThreadID() |
Deprecated. |
Throwable |
getThrown() |
Get any throwable associated with the log record. |
void |
setInstant |
Sets the instant that the event occurred. |
void |
setLevel |
Set the logging message level, for example Level.SEVERE. |
void |
setLoggerName |
Set the source Logger's name. |
LogRecord |
setLongThreadID |
Set an identifier for the thread where the message originated. |
void |
setMessage |
Set the "raw" log message, before localization or formatting. |
void |
setMillis |
Deprecated. LogRecord maintains timestamps with nanosecond resolution, using Instant values. |
void |
setParameters |
Set the parameters to the log message. |
void |
setResourceBundle |
Set the localization resource bundle. |
void |
setResourceBundleName |
Set the localization resource bundle name. |
void |
setSequenceNumber |
Set the sequence number. |
void |
setSourceClassName |
Set the name of the class that (allegedly) issued the logging request. |
void |
setSourceMethodName |
Set the name of the method that (allegedly) issued the logging request. |
void |
setThreadID |
Deprecated. This method doesn't allow to pass a long thread id, use setLongThreadID(long) instead. |
void |
setThrown |
Set a throwable associated with the log event. |
public LogRecord(Level level, String msg)
The sequence property will be initialized with a new unique value. These sequence values are allocated in increasing order within a VM.
Since JDK 9, the event time is represented by an Instant
. The instant property will be initialized to the current instant, using the best available clock on the system.
The thread ID property will be initialized with a unique ID for the current thread.
All other properties will be initialized to "null".
level
- a logging level valuemsg
- the raw non-localized logging message (may be null)public String getLoggerName()
public void setLoggerName(String name)
name
- the source logger name (may be null)public ResourceBundle getResourceBundle()
This is the ResourceBundle that should be used to localize the message string before formatting it. The result may be null if the message is not localizable, or if no suitable ResourceBundle is available.
public void setResourceBundle(ResourceBundle bundle)
bundle
- localization bundle (may be null)public String getResourceBundleName()
This is the name for the ResourceBundle that should be used to localize the message string before formatting it. The result may be null if the message is not localizable.
public void setResourceBundleName(String name)
name
- localization bundle name (may be null)public Level getLevel()
public void setLevel(Level level)
level
- the logging message levelpublic long getSequenceNumber()
Sequence numbers are normally assigned in the LogRecord constructor, which assigns unique sequence numbers to each new LogRecord in increasing order.
public void setSequenceNumber(long seq)
Sequence numbers are normally assigned in the LogRecord constructor, so it should not normally be necessary to use this method.
seq
- the sequence numberpublic String getSourceClassName()
Note that this sourceClassName is not verified and may be spoofed. This information may either have been provided as part of the logging call, or it may have been inferred automatically by the logging framework. In the latter case, the information may only be approximate and may in fact describe an earlier call on the stack frame.
May be null if no information could be obtained.
public void setSourceClassName(String sourceClassName)
sourceClassName
- the source class name (may be null)public String getSourceMethodName()
Note that this sourceMethodName is not verified and may be spoofed. This information may either have been provided as part of the logging call, or it may have been inferred automatically by the logging framework. In the latter case, the information may only be approximate and may in fact describe an earlier call on the stack frame.
May be null if no information could be obtained.
public void setSourceMethodName(String sourceMethodName)
sourceMethodName
- the source method name (may be null)public String getMessage()
May be null, which is equivalent to the empty string "".
This message may be either the final text or a localization key.
During formatting, if the source logger has a localization ResourceBundle and if that ResourceBundle has an entry for this message string, then the message string is replaced with the localized value.
public void setMessage(String message)
message
- the raw message string (may be null)public Object[] getParameters()
public void setParameters(Object[] parameters)
parameters
- the log message parameters. (may be null)@Deprecated(since="16") public int getThreadID()
getLongThreadID()
instead.This is a thread identifier within the Java VM and may or may not map to any operating system ID.
@Deprecated(since="16") public void setThreadID(int threadID)
setLongThreadID(long)
instead.threadID
- the thread IDpublic long getLongThreadID()
This is a thread identifier within the Java VM and may or may not map to any operating system ID.
public LogRecord setLongThreadID(long longThreadID)
longThreadID
- the thread IDpublic long getMillis()
getInstant()
.getInstant().toEpochMilli()
.@Deprecated public void setMillis(long millis)
Instant
values. For this reason, setInstant()
should be used in preference to setMillis()
.setInstant(Instant.ofEpochMilli(millis))
.millis
- event time in millis since 1970.public Instant getInstant()
public void setInstant(Instant instant)
If the given instant
represents a point on the time-line too far in the future or past to fit in a long
milliseconds and nanoseconds adjustment, then an ArithmeticException
will be thrown.
instant
- the instant that the event occurred.NullPointerException
- if instant
is null.ArithmeticException
- if numeric overflow would occur while calling instant.toEpochMilli()
.public Throwable getThrown()
If the event involved an exception, this will be the exception object. Otherwise null.
public void setThrown(Throwable thrown)
thrown
- a throwable (may be null)
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.logging/java/util/logging/LogRecord.html
getLongThreadID()
instead.