Uses of Class
org.jdom2.output.Format
Packages that use Format
Package
Description
Classes to output JDOM documents to various destinations.
Classes used to implement output functionality that are not part of the
actual Output API, but rather part of the implementation.
-
Uses of Format in org.jdom2.output
Methods in org.jdom2.output that return FormatModifier and TypeMethodDescriptionFormat.clone()
static Format
Format.getCompactFormat()
Returns a new Format object that performs whitespace normalization, uses the UTF-8 encoding, doesn't expand empty elements, includes the declaration and encoding, and uses the default entity escape strategy.DOMOutputter.getFormat()
Get the Format instance currently used by this DOMOutputter.SAXOutputter.getFormat()
Get the currentFormat
being used for outputStAXEventOutputter.getFormat()
Returns the current format in use by the StAXStreamOutputter.StAXStreamOutputter.getFormat()
Returns the current format in use by the StAXStreamOutputter.StAXStreamReader.getFormat()
Returns the current format in use by the XMLOutputter.XMLOutputter.getFormat()
Returns the current format in use by the XMLOutputter.static Format
Format.getPrettyFormat()
Returns a new Format object that performs whitespace beautification with 2-space indents, uses the UTF-8 encoding, doesn't expand empty elements, includes the declaration and encoding, and uses the default entity escape strategy.static Format
Format.getRawFormat()
Returns a new Format object that performs no whitespace changes, uses the UTF-8 encoding, doesn't expand empty elements, includes the declaration and encoding, and uses the default entity escape strategy.Format.setEncoding
(String encoding) Sets the output encoding.Format.setEscapeStrategy
(EscapeStrategy strategy) Sets theEscapeStrategy
to use for character escaping.Format.setExpandEmptyElements
(boolean expandEmptyElements) This will set whether empty elements are expanded from<tagName/>
to<tagName></tagName>
.This will set the indentString
to use; this is usually aString
of empty spaces.Format.setLineSeparator
(String separator) This will set the newline separator (LineSeparator
).Format.setLineSeparator
(LineSeparator separator) This will set the newline separator sequence.Format.setOmitDeclaration
(boolean omitDeclaration) This will set whether the XML declaration (<?xml version="1.0"?>
) will be omitted or not.Format.setOmitEncoding
(boolean omitEncoding) This will set whether the XML declaration (<?xml version="1.0" encoding="UTF-8"?>
) includes the encoding of the document.Format.setTextMode
(Format.TextMode mode) This sets the text output style.Methods in org.jdom2.output with parameters of type FormatModifier and TypeMethodDescriptionvoid
Set a new Format instance for this DOMOutputtervoid
Set the currentFormat
to be used for output.void
Sets the new format logic for the StAXStreamOutputter.void
Sets the new format logic for the StAXStreamOutputter.void
Sets the new format logic for the XMLOutputter.void
Sets the new format logic for the XMLOutputter.Constructors in org.jdom2.output with parameters of type FormatModifierConstructorDescriptionDOMOutputter
(DOMAdapter adapter, Format format, DOMOutputProcessor processor) The complete constructor for specifying a custom DOMAdaptor, Format, and DOMOutputProcessor.SAXOutputter
(SAXOutputProcessor processor, Format format, ContentHandler contentHandler, ErrorHandler errorHandler, DTDHandler dtdHandler, EntityResolver entityResolver, LexicalHandler lexicalHandler) This will create aSAXOutputter
with the specified SAX2 handlers.StAXEventOutputter
(Format format) This will create anStAXStreamOutputter
with the specified format characteristics.StAXEventOutputter
(Format format, StAXEventProcessor processor, XMLEventFactory eventfactory) This will create anStAXStreamOutputter
with the specified format characteristics.StAXStreamOutputter
(Format format) This will create anStAXStreamOutputter
with the specified format characteristics.StAXStreamOutputter
(Format format, StAXStreamProcessor processor) This will create anStAXStreamOutputter
with the specified format characteristics.StAXStreamReader
(Format format) This will create anXMLOutputter
with the specified format characteristics.StAXStreamReader
(Format format, StAXStreamReaderProcessor processor) This will create anXMLOutputter
with the specified format characteristics.XMLOutputter
(Format format) This will create anXMLOutputter
with the specified format characteristics.XMLOutputter
(Format format, XMLOutputProcessor processor) This will create anXMLOutputter
with the specified format characteristics. -
Uses of Format in org.jdom2.output.support
Methods in org.jdom2.output.support with parameters of type FormatModifier and TypeMethodDescriptionAbstractStAXStreamReaderProcessor.buildReader
(Document doc, Format format) StAXStreamReaderProcessor.buildReader
(Document doc, Format format) Return an implementation of an XMLStreamReader that represents a JDOM Document.AbstractDOMOutputProcessor.process
(Document basedoc, Format format, ProcessingInstruction pi) void
void
void
void
void
void
void
void
AbstractSAXOutputProcessor.process
(SAXTarget out, Format format, ProcessingInstruction pi) void
void
AbstractStAXEventProcessor.process
(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, List<? extends Content> list) void
AbstractStAXEventProcessor.process
(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, CDATA cdata) void
AbstractStAXEventProcessor.process
(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, Comment comment) void
AbstractStAXEventProcessor.process
(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, DocType doctype) void
AbstractStAXEventProcessor.process
(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, Document doc) void
AbstractStAXEventProcessor.process
(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, Element element) void
AbstractStAXEventProcessor.process
(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, EntityRef entity) void
AbstractStAXEventProcessor.process
(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, ProcessingInstruction pi) void
AbstractStAXEventProcessor.process
(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, Text text) void
AbstractStAXStreamProcessor.process
(XMLStreamWriter out, Format format, List<? extends Content> list) void
AbstractStAXStreamProcessor.process
(XMLStreamWriter out, Format format, CDATA cdata) void
AbstractStAXStreamProcessor.process
(XMLStreamWriter out, Format format, Comment comment) void
AbstractStAXStreamProcessor.process
(XMLStreamWriter out, Format format, DocType doctype) void
AbstractStAXStreamProcessor.process
(XMLStreamWriter out, Format format, Document doc) void
AbstractStAXStreamProcessor.process
(XMLStreamWriter out, Format format, Element element) void
AbstractStAXStreamProcessor.process
(XMLStreamWriter out, Format format, EntityRef entity) void
AbstractStAXStreamProcessor.process
(XMLStreamWriter out, Format format, ProcessingInstruction pi) void
AbstractStAXStreamProcessor.process
(XMLStreamWriter out, Format format, Text text) void
void
void
void
void
void
void
void
AbstractXMLOutputProcessor.process
(Writer out, Format format, ProcessingInstruction pi) void
This will convert the list of JDOM
using the given DOM Document to create the resulting list of DOM Nodes.Content
This will convert the
using the given DOM Document to create the resulting DOM Attr.Attribute
This will convert the
using the given DOM Document to create the resulting DOM CDATASection.CDATA
This will convert the
using the given DOM Document to create the resulting DOM Comment.Comment
This will convert the
to the given DOM Document.Document
This will convert the
using the given DOM Document to create the resulting DOM Element.Element
This will convert the
using the given DOM Document to create the resulting DOM EntityReference.EntityRef
DOMOutputProcessor.process
(Document basedoc, Format format, ProcessingInstruction pi) This will convert the
using the given DOM Document to create the resulting DOM ProcessingInstruction.ProcessingInstruction
This will convert the
using the given DOM Document to create the resulting DOM Text.Text
void
This will handle printing out a list of nodes.void
Print out a
node.CDATA
void
Print out a
.Comment
void
Print out the
.DocType
void
This will print the
to the given SAXTarget.Document
void
void
Print out a
.EntityRef
void
SAXOutputProcessor.process
(SAXTarget out, Format format, ProcessingInstruction pi) Print out a
.ProcessingInstruction
void
Print out a
node.Text
void
StAXEventProcessor.process
(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, List<? extends Content> list) This will handle printing out a list of nodes.void
StAXEventProcessor.process
(XMLEventConsumer out, Format format, XMLEventFactory eventfactpry, CDATA cdata) Print out a
node.CDATA
void
StAXEventProcessor.process
(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, Comment comment) Print out a
.Comment
void
StAXEventProcessor.process
(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, DocType doctype) Print out the
.DocType
void
StAXEventProcessor.process
(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, Document doc) This will print the
to the given XMLEventConsumer.Document
void
StAXEventProcessor.process
(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, Element element) void
StAXEventProcessor.process
(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, EntityRef entity) Print out a
.EntityRef
void
StAXEventProcessor.process
(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, ProcessingInstruction pi) Print out a
.ProcessingInstruction
void
StAXEventProcessor.process
(XMLEventConsumer out, Format format, XMLEventFactory eventfactory, Text text) Print out a
node.Text
void
StAXStreamProcessor.process
(XMLStreamWriter out, Format format, List<? extends Content> list) This will handle printing out a list of nodes.void
StAXStreamProcessor.process
(XMLStreamWriter out, Format format, CDATA cdata) Print out a
node.CDATA
void
StAXStreamProcessor.process
(XMLStreamWriter out, Format format, Comment comment) Print out a
.Comment
void
StAXStreamProcessor.process
(XMLStreamWriter out, Format format, DocType doctype) Print out the
.DocType
void
StAXStreamProcessor.process
(XMLStreamWriter out, Format format, Document doc) This will print the
to the given XMLStreamWriter.Document
void
StAXStreamProcessor.process
(XMLStreamWriter out, Format format, Element element) void
StAXStreamProcessor.process
(XMLStreamWriter out, Format format, EntityRef entity) Print out a
.EntityRef
void
StAXStreamProcessor.process
(XMLStreamWriter out, Format format, ProcessingInstruction pi) Print out a
.ProcessingInstruction
void
StAXStreamProcessor.process
(XMLStreamWriter out, Format format, Text text) Print out a
node.Text
void
This will handle printing out a list of nodes.void
Print out a
node.CDATA
void
Print out a
.Comment
void
Print out the
.DocType
void
This will print the
to the given Writer.Document
void
void
Print out a
.EntityRef
void
XMLOutputProcessor.process
(Writer out, Format format, ProcessingInstruction pi) Print out a
.ProcessingInstruction
void
Print out a
node.Text
void
AbstractSAXOutputProcessor.processAsDocument
(SAXTarget out, Format format, List<? extends Content> nodes) void
AbstractSAXOutputProcessor.processAsDocument
(SAXTarget out, Format format, Element node) void
SAXOutputProcessor.processAsDocument
(SAXTarget out, Format format, List<? extends Content> list) This will handle printing out a list of nodes that is encapsulated in start/end Document SAX events.void
SAXOutputProcessor.processAsDocument
(SAXTarget out, Format format, Element element) Constructors in org.jdom2.output.support with parameters of type FormatModifierConstructorDescriptionAbstractStAXStreamReader
(Document document, Format format) Create a new AbstractStAXStreamReader that outputs a JDOM Document as an XMLStream.FormatStack
(Format format) Creates a new FormatStack seeded with the specified Format