com.sun.xml.bind.marshaller

Class DataWriter

public class DataWriter extends XMLWriter

Write data- or field-oriented XML.

This filter pretty-prints field-oriented XML without mixed content. all added indentation and newlines will be passed on down the filter chain (if any).

In general, all whitespace in an XML document is potentially significant, so a general-purpose XML writing tool like the XMLWriter class cannot add newlines or indentation.

There is, however, a large class of XML documents where information is strictly fielded: each element contains either character data or other elements, but not both. For this special case, it is possible for a writing tool to provide automatic indentation and newlines without requiring extra work from the user. Note that this class will likely not yield appropriate results for document-oriented XML like XHTML pages, which mix character data and elements together.

This writer will automatically place each start tag on a new line, optionally indented if an indent step is provided (by default, there is no indentation). If an element contains other elements, the end tag will also appear on a new line with leading indentation. Consider, for example, the following code:

 DataWriter w = new DataWriter();

 w.setIndentStep(2);
 w.startDocument();
 w.startElement("Person");
 w.dataElement("name", "Jane Smith");
 w.dataElement("date-of-birth", "1965-05-23");
 w.dataElement("citizenship", "US");
 w.endElement("Person");
 w.endDocument();
 

This code will produce the following document:

 <?xml version="1.0" standalone="yes"?>

 <Person>
   <name>Jane Smith</name>
   <date-of-birth>1965-05-23</date-of-birth>
   <citizenship>US</citizenship>
 </Person>
 

This class inherits from XMLWriter, and provides all of the same support for Namespaces.

Since: 1.0

See Also: XMLWriter

Constructor Summary
DataWriter(Writer writer, String encoding, CharacterEscapeHandler _escapeHandler)
Create a new data writer for the specified output.
DataWriter(Writer writer, String encoding)
Method Summary
voidcharacters(char[] ch, int start, int length)
Write a sequence of characters.
voidendDocument()
voidendElement(String uri, String localName, String qName)
Write an end tag.
intgetIndentStep()
Return the current indent step.
voidreset()
Reset the writer so that it can be reused.
voidsetIndentStep(int indentStep)
Set the current indent step.
voidsetIndentStep(String s)
voidstartElement(String uri, String localName, String qName, Attributes atts)
Write a start tag.
protected voidwriteXmlDecl(String decl)

Constructor Detail

DataWriter

public DataWriter(Writer writer, String encoding, CharacterEscapeHandler _escapeHandler)
Create a new data writer for the specified output.

Parameters: writer The character stream where the XML document will be written. encoding If non-null string is specified, it is written as a part of the XML declaration.

DataWriter

public DataWriter(Writer writer, String encoding)

Method Detail

characters

public void characters(char[] ch, int start, int length)
Write a sequence of characters.

Parameters: ch The characters to write. start The starting position in the array. length The number of characters to use.

Throws: org.xml.sax.SAXException If there is an error writing the characters, or if a filter further down the chain raises an exception.

See Also: (char[], int, int)

endDocument

public void endDocument()

endElement

public void endElement(String uri, String localName, String qName)
Write an end tag.

If the element has contained other elements, the tag will appear indented on a new line; otherwise, it will appear immediately following whatever came before.

The newline and indentation will be passed on down the filter chain through regular characters events.

Parameters: uri The element's Namespace URI. localName The element's local name. qName The element's qualified (prefixed) name.

Throws: org.xml.sax.SAXException If there is an error writing the end tag, or if a filter further down the chain raises an exception.

See Also: XMLWriter

getIndentStep

public int getIndentStep()

Deprecated: Only return the length of the indent string.

Return the current indent step.

Return the current indent step: each start tag will be indented by this number of spaces times the number of ancestors that the element has.

Returns: The number of spaces in each indentation step, or 0 or less for no indentation.

See Also:

reset

public void reset()
Reset the writer so that it can be reused.

This method is especially useful if the writer failed with an exception the last time through.

See Also: reset

setIndentStep

public void setIndentStep(int indentStep)

Deprecated: Should use the version that takes string.

Set the current indent step.

Parameters: indentStep The new indent step (0 or less for no indentation).

See Also:

setIndentStep

public void setIndentStep(String s)

startElement

public void startElement(String uri, String localName, String qName, Attributes atts)
Write a start tag.

Each tag will begin on a new line, and will be indented by the current indent step times the number of ancestors that the element has.

The newline and indentation will be passed on down the filter chain through regular characters events.

Parameters: uri The element's Namespace URI. localName The element's local name. qName The element's qualified (prefixed) name. atts The element's attribute list.

Throws: org.xml.sax.SAXException If there is an error writing the start tag, or if a filter further down the chain raises an exception.

See Also: XMLWriter

writeXmlDecl

protected void writeXmlDecl(String decl)