public class XMLFormatter extends Formatter
The DTD specification is provided as Appendix A to the Java Logging APIs specification.
The XMLFormatter can be used with arbitrary character encodings, but it is recommended that it normally be used with UTF-8. The character encoding can be set on the output Handler.
Instant
which can have nanoseconds below the millisecond resolution. The DTD specification has been updated to allow for an optional <nanos>
element. By default, the XMLFormatter will compute the nanosecond adjustment below the millisecond resolution (using LogRecord.getInstant().getNano() % 1000_000
) - and if this is not 0, this adjustment value will be printed in the new <nanos>
element. The event instant can then be reconstructed using Instant.ofEpochSecond(millis/1000L, (millis % 1000L) * 1000_000L + nanos)
where millis
and nanos
represent the numbers serialized in the <millis>
and <nanos>
elements, respectively. <date>
element will now contain the whole instant as formatted by the DateTimeFormatter.ISO_INSTANT
formatter. For compatibility with old parsers, XMLFormatters can be configured to revert to the old format by specifying a <xml-formatter-fully-qualified-class-name>.useInstant = false
property in the logging configuration. When useInstant
is false
, the old formatting will be preserved. When useInstant
is true
(the default), the <nanos>
element will be printed and the <date>
element will contain the formatted instant.
For instance, in order to configure plain instances of XMLFormatter to omit the new <nano>
element, java.util.logging.XMLFormatter.useInstant = false
can be specified in the logging configuration.
Constructor | Description |
---|---|
XMLFormatter() |
Creates a new instance of XMLFormatter. |
formatMessage
public XMLFormatter()
<date>
element will contain the instant as formatted by the DateTimeFormatter.ISO_INSTANT
. In addition, an optional <nanos>
element containing a nanosecond adjustment will be printed if the instant contains some nanoseconds below the millisecond resolution. This new behavior can be turned off, and the old formatting restored, by specifying a property in the logging configuration. If LogManager.getLogManager().getProperty(
this.getClass().getName()+".useInstant")
is "false"
or "0"
, the old formatting will be restored.
public String format(LogRecord record)
This method can be overridden in a subclass. It is recommended to use the Formatter.formatMessage(java.util.logging.LogRecord)
convenience method to localize and format the message field.
public String getHead(Handler h)
public String getTail(Handler h)
© 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/XMLFormatter.html