com.xmlmind.xml.save

Class DocumentIndenter

java.lang.Object

com.xmlmind.xml.save.DocumentWriter

com.xmlmind.xml.save.DocumentIndenter

Direct Known Subclasses:

DocumentIndenter

public class DocumentIndenter
extends DocumentWriter

Low-level document writer. Can generate indented output.

Will not add whitespace (indentation), unless this whitespace is ignoreable according to the document type of the document to be saved.

See Also:

DocumentWriter, SaveDocument

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	DocumentIndenter.Layout
protected class	DocumentIndenter.State

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	addOpenLines
protected boolean	guessContentType
protected boolean[]	guessed
protected int	indent
static int	MAX_INDENT Largest value for the indentation.
protected int	maxLineLength
static int	MIN_LINE_LENGTH Smallest value for the maximum line length.
protected DocumentIndenter.State[]	stateStack
protected int	stateStackSize
protected Structure	structure

Fields inherited from class com.xmlmind.xml.save.DocumentWriter

cdataSections, documentType, duplicateIDFilter, favorInteroperability, filterDuplicateIDs, out, predeclarePrefixPrefs, preserveInclusions, qNameHelper, textHelper

Constructor Summary

Constructors

Constructor and Description
DocumentIndenter(Writer out) Constructs a writer writing XML to specified output.

Method Summary

Modifier and Type	Method and Description
protected int	computeLineEnd(int lineFirst)
protected DocumentIndenter.State	createInitialState()
boolean	getAddOpenLines() Returns true if an open line is added between the child elements of a parent element (if the content model of the parent only allows child elements).
protected static String	getElementAttribute(Element element, ElementType elementType, Name attributeName, AttributeDefaultValue defaultValue)
int	getIndent() Returns the number of space characters used to indent a child element relatively to its parent element.
int	getMaxLineLength() Returns the maximum line length for elements containing text interspersed with child elements.
protected boolean	hasEmptyContentType(Element element)
protected void	popElement()
protected void	popInclusion()
protected void	popState()
protected void	pushElement(Element element)
protected void	pushInclusion(Inclusion inclusion, Node firstIncludedNode, Node lastIncludedNode, Node[] inclusionSpec)
protected void	pushState(DocumentIndenter.State state)
void	setAddOpenLines(boolean add) If specified value is true, an open line is added between the child elements of a parent element (if the content model of the parent only allows child elements).
void	setDocumentType(DocumentType documentType) Specifies the document type of the document to be saved.
void	setIndent(int indent) Specifies the number of space characters used to indent a child element relatively to its parent element.
void	setMaxLineLength(int length) Specifies the maximum line length for elements containing text interspersed with child elements.
protected DocumentIndenter.State	topState()
void	write(Document document) Save specified document.
void	write(Element element) Save specified element as a document.
protected void	writeAttribute(String tag, String value)
protected void	writeCDATA(Text text, Element element)
protected void	writeComment(Comment comment)
protected void	writeElement(Element element)
protected void	writeEmptyEndTag(String tag, Element element)
protected void	writeEndTag(String tag, Element element)
protected void	writeInclusion(Inclusion inclusion, Node firstIncludedNode, Node lastIncludedNode)
protected void	writeProcessingInstruction(ProcessingInstruction pi)
protected void	writeStartTag(String tag, Element element)
protected void	writeText(Text text)

Methods inherited from class com.xmlmind.xml.save.DocumentWriter

addXMLBase, beginWrite, beginWrite, checkComment, checkProcessingInstruction, endWrite, endWrite, flush, getCdataSectionElements, getCharEntities, getCharsSavedAsEntityRefs, getDocumentType, getEncoding, getFavorInteroperability, getFilterDuplicateIDs, getPredeclarePrefixPreferences, getPrefixPreferences, getPreserveInclusions, getWriter, isEmptyElement, predeclarePrefixPrefs, setCdataSectionElements, setCharEntities, setCharsSavedAsEntityRefs, setEncoding, setFavorInteroperability, setFilterDuplicateIDs, setPredeclarePrefixPreferences, setPrefixPreferences, setPreserveInclusions, shorten, writeAttributes, writeDocumentTypeDeclaration, writeElementProperties, writeEntityRef, writeFrame

Methods inherited from class java.lang.Object

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

Field Detail

MAX_INDENT

public static final int MAX_INDENT

Largest value for the indentation.

See Also:

setIndent(int), Constant Field Values

MIN_LINE_LENGTH

public static final int MIN_LINE_LENGTH

Smallest value for the maximum line length.

See Also:

setMaxLineLength(int), Constant Field Values

guessContentType

protected boolean guessContentType

indent

protected int indent

maxLineLength

protected int maxLineLength

addOpenLines

protected boolean addOpenLines

stateStack

protected DocumentIndenter.State[] stateStack

stateStackSize

protected int stateStackSize

structure

protected Structure structure

guessed

protected boolean[] guessed

Constructor Detail

DocumentIndenter

public DocumentIndenter(Writer out)

Constructs a writer writing XML to specified output.

Method Detail

setDocumentType

public void setDocumentType(DocumentType documentType)

Description copied from class: DocumentWriter

Specifies the document type of the document to be saved. May be null.

Overrides:

setDocumentType in class DocumentWriter

setIndent

public void setIndent(int indent)

Specifies the number of space characters used to indent a child element relatively to its parent element.

Default: 2.

A negative value is adjusted to 0. A value greater than MAX_INDENT is adjusted to MAX_INDENT.

getIndent

public int getIndent()

Returns the number of space characters used to indent a child element relatively to its parent element.

setMaxLineLength

public void setMaxLineLength(int length)

Specifies the maximum line length for elements containing text interspersed with child elements.

Default: 78.

This is just a hint: lines written by this formatter may be much longer that specified value.

A value negative or null may be used to specify an unbound maximum line length. A positive value smaller than MIN_LINE_LENGTH is adjusted to MIN_LINE_LENGTH.

getMaxLineLength

public int getMaxLineLength()

Returns the maximum line length for elements containing text interspersed with child elements.

setAddOpenLines

public void setAddOpenLines(boolean add)

If specified value is true, an open line is added between the child elements of a parent element (if the content model of the parent only allows child elements).

Default: true.

getAddOpenLines

public boolean getAddOpenLines()

Returns true if an open line is added between the child elements of a parent element (if the content model of the parent only allows child elements). Returns false otherwise.

write

public void write(Document document)
           throws IOException

Description copied from class: DocumentWriter

Save specified document.

The saved file does not automatically start with a XML declaration <?xml version="...." ?>. You need to use SaveDocument.writeXMLDeclaration(java.lang.String, java.lang.String, java.lang.String, java.io.Writer) for that.

Overrides:

write in class DocumentWriter

Parameters:

document - Document to be saved.

Throws:

IOException - if, for any reason, the document cannot be saved.

write

public void write(Element element)
           throws IOException

Description copied from class: DocumentWriter

Save specified element as a document.

The saved file does not automatically start with a XML declaration <?xml version="...." ?>. You need to use SaveDocument.writeXMLDeclaration(java.lang.String, java.lang.String, java.lang.String, java.io.Writer) for that.

Overrides:

write in class DocumentWriter

Parameters:

element - Element to be saved.

Throws:

IOException - if, for any reason, the element cannot be saved.

writeComment

protected void writeComment(Comment comment)
                     throws IOException

Overrides:

writeComment in class DocumentWriter

Throws:

IOException

writeProcessingInstruction

protected void writeProcessingInstruction(ProcessingInstruction pi)
                                   throws IOException

Overrides:

writeProcessingInstruction in class DocumentWriter

Throws:

IOException

writeInclusion

protected void writeInclusion(Inclusion inclusion,
                              Node firstIncludedNode,
                              Node lastIncludedNode)
                       throws IOException

Overrides:

writeInclusion in class DocumentWriter

Throws:

IOException

writeElement

protected void writeElement(Element element)
                     throws IOException

Overrides:

writeElement in class DocumentWriter

Throws:

IOException

writeStartTag

protected void writeStartTag(String tag,
                             Element element)
                      throws IOException

Overrides:

writeStartTag in class DocumentWriter

Throws:

IOException

writeAttribute

protected void writeAttribute(String tag,
                              String value)
                       throws IOException

Overrides:

writeAttribute in class DocumentWriter

Throws:

IOException

writeEmptyEndTag

protected void writeEmptyEndTag(String tag,
                                Element element)
                         throws IOException

Overrides:

writeEmptyEndTag in class DocumentWriter

Throws:

IOException

hasEmptyContentType

protected boolean hasEmptyContentType(Element element)

Overrides:

hasEmptyContentType in class DocumentWriter

writeEndTag

protected void writeEndTag(String tag,
                           Element element)
                    throws IOException

Overrides:

writeEndTag in class DocumentWriter

Throws:

IOException

writeCDATA

protected void writeCDATA(Text text,
                          Element element)
                   throws IOException

Overrides:

writeCDATA in class DocumentWriter

Throws:

IOException

writeText

protected void writeText(Text text)
                  throws IOException

Overrides:

writeText in class DocumentWriter

Throws:

IOException

createInitialState

protected DocumentIndenter.State createInitialState()

pushElement

protected void pushElement(Element element)

Overrides:

pushElement in class DocumentWriter

getElementAttribute

protected static String getElementAttribute(Element element,
                                            ElementType elementType,
                                            Name attributeName,
                                            AttributeDefaultValue defaultValue)

computeLineEnd

protected int computeLineEnd(int lineFirst)

popElement

protected void popElement()

Overrides:

popElement in class DocumentWriter

pushInclusion

protected void pushInclusion(Inclusion inclusion,
                             Node firstIncludedNode,
                             Node lastIncludedNode,
                             Node[] inclusionSpec)

popInclusion

protected void popInclusion()

pushState

protected void pushState(DocumentIndenter.State state)

popState

protected void popState()

topState

protected DocumentIndenter.State topState()