Package org.apache.sis.internal.storage.xml.stream

Class FormattedWriter

java.lang.Object

org.apache.sis.internal.xml.StreamWriterDelegate

org.apache.sis.internal.storage.xml.stream.FormattedWriter

All Implemented Interfaces:

XMLStreamWriter

final class FormattedWriter
extends StreamWriterDelegate

Adds indentation to a XML output.

Design note: an alternative approach would have been to provide startIdentation() and endIndentation() convenience methods in StaxStreamWriter, and let subclasses perform their own formatting. It would reduce the need to try to guess some formatting aspects (e.g. whether to format on a single line or not). However, that approach does not integrate very well with JAXB; the Marshaller.JAXB_FORMATTED_OUTPUT property seems to be ignored when marshalling a fragment using XMLStreamWriter. Even if that property was supported, there is no standard way as of JDK8 to tell to JAXB to begin the indentation at some level (for taking in account the indentation of the elements containing the fragment to marshal with JAXB).

Since:

0.8

Version:

0.8

Field Summary

Fields

Modifier and Type	Field	Description
private final int	indentation	Number of spaces to add for each new indentation level.
private boolean	inline	true if the last writeStartElement(…) method invocation has not yet been followed by a writeEndElement(…) method invocation.
private final String	lineSeparator	The line separator to use.
private int	margin	The number of spaces to write before next XML start tags.
private static final char[]	SPACES	A predefined amount of spaces, used by indent() for writing a greater amount of spaces in one call to XMLStreamWriter.writeCharacters(char[], int, int) methods.

Fields inherited from class org.apache.sis.internal.xml.StreamWriterDelegate

out

Constructor Summary

Constructors

Constructor	Description
FormattedWriter(XMLStreamWriter out, int indentation)	Creates a new XML writer with indentation.

Method Summary

Modifier and Type	Method	Description
private void	emptyIndent()	Appends indentation before an empty tag.
private void	indent()	Writes a line separator, then the given amount of spaces.
(package private) final void	startIndent()	Increases the indentation level and appends indentation before a start tag.
void	writeEmptyElement(String localName)	Appends indentation, then forwards the call verbatim.
void	writeEmptyElement(String namespaceURI, String localName)	Appends indentation, then forwards the call verbatim.
void	writeEmptyElement(String prefix, String localName, String namespaceURI)	Appends indentation, then forwards the call verbatim.
void	writeEndDocument()	Appends a new line after the document.
void	writeEndElement()	Appends indentation if the value is not inline, then forwards the call verbatim.
void	writeStartElement(String localName)	Appends indentation, then forwards the call verbatim.
void	writeStartElement(String namespaceURI, String localName)	Appends indentation, then forwards the call verbatim.
void	writeStartElement(String prefix, String localName, String namespaceURI)	Appends indentation, then forwards the call verbatim.

Methods inherited from class org.apache.sis.internal.xml.StreamWriterDelegate

close, flush, getNamespaceContext, getPrefix, getProperty, setDefaultNamespace, setNamespaceContext, setPrefix, writeAttribute, writeAttribute, writeAttribute, writeCData, writeCharacters, writeCharacters, writeComment, writeDefaultNamespace, writeDTD, writeEntityRef, writeNamespace, writeProcessingInstruction, writeProcessingInstruction, writeStartDocument, writeStartDocument, writeStartDocument

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SPACES

private static final char[] SPACES

A predefined amount of spaces, used by indent() for writing a greater amount of spaces in one call to XMLStreamWriter.writeCharacters(char[], int, int) methods.

lineSeparator

private final String lineSeparator

The line separator to use.

indentation

private final int indentation

Number of spaces to add for each new indentation level.

margin

private int margin

The number of spaces to write before next XML start tags. This value is incremented or decremented by the indentation value every time a XML start element or end element is encountered.

inline

private boolean inline

true if the last writeStartElement(…) method invocation has not yet been followed by a writeEndElement(…) method invocation. In such case, the start and end tags can be written on the same line.

Constructor Details

FormattedWriter

FormattedWriter(XMLStreamWriter out,
 int indentation)
         throws XMLStreamException

Creates a new XML writer with indentation.

Parameters:

out - where to write the XML.

Throws:

XMLStreamException

Method Details

indent

private void indent()
             throws XMLStreamException

Writes a line separator, then the given amount of spaces.

Throws:

XMLStreamException

emptyIndent

private void emptyIndent()
                  throws XMLStreamException

Appends indentation before an empty tag.

Throws:

XMLStreamException

startIndent

final void startIndent()
                throws XMLStreamException

Increases the indentation level and appends indentation before a start tag.

Throws:

XMLStreamException

writeStartElement

public void writeStartElement(String localName)
                       throws XMLStreamException

Appends indentation, then forwards the call verbatim.

Specified by:

writeStartElement in interface XMLStreamWriter

Overrides:

writeStartElement in class StreamWriterDelegate

Throws:

XMLStreamException

writeStartElement

public void writeStartElement(String namespaceURI,
 String localName)
                       throws XMLStreamException

Appends indentation, then forwards the call verbatim.

Specified by:

writeStartElement in interface XMLStreamWriter

Overrides:

writeStartElement in class StreamWriterDelegate

Throws:

XMLStreamException

writeStartElement

public void writeStartElement(String prefix,
 String localName,
 String namespaceURI)
                       throws XMLStreamException

Appends indentation, then forwards the call verbatim.

Specified by:

writeStartElement in interface XMLStreamWriter

Overrides:

writeStartElement in class StreamWriterDelegate

Throws:

XMLStreamException

writeEmptyElement

public void writeEmptyElement(String namespaceURI,
 String localName)
                       throws XMLStreamException

Appends indentation, then forwards the call verbatim.

Specified by:

writeEmptyElement in interface XMLStreamWriter

Overrides:

writeEmptyElement in class StreamWriterDelegate

Throws:

XMLStreamException

writeEmptyElement

public void writeEmptyElement(String prefix,
 String localName,
 String namespaceURI)
                       throws XMLStreamException

Appends indentation, then forwards the call verbatim.

Specified by:

writeEmptyElement in interface XMLStreamWriter

Overrides:

writeEmptyElement in class StreamWriterDelegate

Throws:

XMLStreamException

writeEmptyElement

public void writeEmptyElement(String localName)
                       throws XMLStreamException

Appends indentation, then forwards the call verbatim.

Specified by:

writeEmptyElement in interface XMLStreamWriter

Overrides:

writeEmptyElement in class StreamWriterDelegate

Throws:

XMLStreamException

writeEndElement

public void writeEndElement()
                     throws XMLStreamException

Appends indentation if the value is not inline, then forwards the call verbatim.

Specified by:

writeEndElement in interface XMLStreamWriter

Overrides:

writeEndElement in class StreamWriterDelegate

Throws:

XMLStreamException

writeEndDocument

public void writeEndDocument()
                      throws XMLStreamException

Appends a new line after the document.

Specified by:

writeEndDocument in interface XMLStreamWriter

Overrides:

writeEndDocument in class StreamWriterDelegate

Throws:

XMLStreamException