XMLFormatter (Java Platform SE 8 ) (original) (raw)

• java.lang.Object

• • java.util.logging.Formatter
  • • java.util.logging.XMLFormatter

• ---

public class XMLFormatter
extends Formatter
Format a LogRecord into a standard XML format.
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.
Since:
1.4

• • Constructor Summary

  Constructors

  Constructor	Description
  XMLFormatter()

  • Method Summary

  All Methods Instance Methods Concrete Methods

  Modifier and Type	Method	Description
  String	format(LogRecord record)	Format the given message to XML.
  String	getHead(Handler h)	Return the header string for a set of XML formatted records.
  String	getTail(Handler h)	Return the tail string for a set of XML formatted records.

     * ### Methods inherited from class java.util.logging.[Formatter](../../../java/util/logging/Formatter.html "class in java.util.logging")  
     `[formatMessage](../../../java/util/logging/Formatter.html#formatMessage-java.util.logging.LogRecord-)`  
     * ### Methods inherited from class java.lang.[Object](../../../java/lang/Object.html "class in java.lang")  
     `[clone](../../../java/lang/Object.html#clone--), [equals](../../../java/lang/Object.html#equals-java.lang.Object-), [finalize](../../../java/lang/Object.html#finalize--), [getClass](../../../java/lang/Object.html#getClass--), [hashCode](../../../java/lang/Object.html#hashCode--), [notify](../../../java/lang/Object.html#notify--), [notifyAll](../../../java/lang/Object.html#notifyAll--), [toString](../../../java/lang/Object.html#toString--), [wait](../../../java/lang/Object.html#wait--), [wait](../../../java/lang/Object.html#wait-long-), [wait](../../../java/lang/Object.html#wait-long-int-)`

• • Constructor Detail

     * #### XMLFormatter  
     public XMLFormatter()  

  • Method Detail

    * #### format  
    public [String](../../../java/lang/String.html "class in java.lang") format([LogRecord](../../../java/util/logging/LogRecord.html "class in java.util.logging") record)  
    Specified by:  
    `[format](../../../java/util/logging/Formatter.html#format-java.util.logging.LogRecord-)` in class `[Formatter](../../../java/util/logging/Formatter.html "class in java.util.logging")`  
    Parameters:  
    `record` \- the log record to be formatted.  
    Returns:  
    a formatted log record  
    * #### getHead  
    public [String](../../../java/lang/String.html "class in java.lang") getHead([Handler](../../../java/util/logging/Handler.html "class in java.util.logging") h)  
    Return the header string for a set of XML formatted records.  
    Overrides:  
    `[getHead](../../../java/util/logging/Formatter.html#getHead-java.util.logging.Handler-)` in class `[Formatter](../../../java/util/logging/Formatter.html "class in java.util.logging")`  
    Parameters:  
    `h` \- The target handler (can be null)  
    Returns:  
    a valid XML string  
    * #### getTail  
    public [String](../../../java/lang/String.html "class in java.lang") getTail([Handler](../../../java/util/logging/Handler.html "class in java.util.logging") h)  
    Return the tail string for a set of XML formatted records.  
    Overrides:  
    `[getTail](../../../java/util/logging/Formatter.html#getTail-java.util.logging.Handler-)` in class `[Formatter](../../../java/util/logging/Formatter.html "class in java.util.logging")`  
    Parameters:  
    `h` \- The target handler (can be null)  
    Returns:  
    a valid XML string

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2025, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.