Stay organized with collections
Save and categorize content based on your preferences.
open class XMLFormatter : 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.
Summary
Public methods |
open String! |
Format the given message to XML.
|
open String! |
Return the header string for a set of XML formatted records.
|
open String! |
Return the tail string for a set of XML formatted records.
|
Inherited functions |
From class Formatter
String! |
formatMessage(record: LogRecord!)
Localize and format the message string from a log record. This method is provided as a convenience for Formatter subclasses to use when they are performing formatting.
The message string is first localized to a format string using the record's ResourceBundle. (If there is no ResourceBundle, or if the message key is not found, then the key is used as the format string.) The format String uses java.text style formatting.
- If there are no parameters, no formatter is used.
- Otherwise, if the string contains "{0" then java.text.MessageFormat is used to format the string.
- Otherwise no formatting is performed.
|
|
Public constructors
Public methods
open fun format(record: LogRecord!): String!
Format the given message to XML.
This method can be overridden in a subclass. It is recommended to use the Formatter#formatMessage
convenience method to localize and format the message field.
Parameters |
record |
LogRecord!: the log record to be formatted. |
Return |
String! |
a formatted log record |
getHead
open fun getHead(h: Handler!): String!
Return the header string for a set of XML formatted records.
Parameters |
h |
Handler!: The target handler (can be null) |
Return |
String! |
a valid XML string |
getTail
open fun getTail(h: Handler!): String!
Return the tail string for a set of XML formatted records.
Parameters |
h |
Handler!: The target handler (can be null) |
Return |
String! |
a valid XML string |
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2021-02-18 UTC.
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"Missing the information I need"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"Too complicated / too many steps"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"Out of date"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"Samples / code issue"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
{"lastModified": "Last updated 2021-02-18 UTC."}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2021-02-18 UTC."]]