Package cdc.util.xml

Class XmlWriter

java.lang.Object

cdc.util.xml.XmlWriter

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable

public class XmlWriter
extends java.lang.Object
implements java.io.Flushable, java.io.Closeable

Basic XML writer.

This class does not support all XML features. It supports specific features:

• Pretty printing
• Name conversion for elements and attributes.
• Standard ('\n') or platform specific End of line.
• ...

WARNING: This class does not check full conformity of generated XML.

Pretty printing
Pretty printing may produce unexpected results with mixed content elements.
This implementation true to produce data as soon as possible.
Discovering that an element has a mixed content may happen late, so that indentation behavior changes after such discovery.
If one knows that an element has a mixed content, it is advised to indicate it to the writer by writing an empty string content first in that element.

Author:

Damien Carbonne

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XmlWriter.Feature	Enumeration of features supported by the writer.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	AMP
static java.lang.String	APOS
protected static java.util.regex.Pattern	CDATA_END_PATTERN
static java.lang.String	CR
static java.lang.String	GT
static java.lang.String	LF
static java.lang.String	LT
static java.lang.String	QUOT
static java.lang.String	TAB

Constructor Summary

Constructors

Constructor	Description
XmlWriter()	Creates an XmlWriter to System.out, with UTF-8 encoding.
XmlWriter(java.io.File file)	Creates an XmlWriter to a file using UTF-8 encoding.
XmlWriter(java.io.File file, java.lang.String encoding)	Creates an XmlWriter to a file with a given encoding.
XmlWriter(java.io.OutputStream os)	Creates an XmlWriter to an OutputStream with UTF-8 encoding.
XmlWriter(java.io.OutputStream os, java.lang.String encoding)	Creates an XmlWriter to an OutputStream with a given encoding.
XmlWriter(java.io.PrintStream out)	Creates an XmlWriter to a PrintStream, with UTF-8 encoding.
XmlWriter(java.io.Writer writer)	Creates an XmlWriter to a Writer, with UTF-8 encoding.
XmlWriter(java.io.Writer writer, java.lang.String encoding)	Creates an XmlWriter to a Writer with a given encoding.
XmlWriter(java.lang.String filename)	Creates an XmlWriter to a file with UTF-8 encoding.
XmlWriter(java.lang.String filename, java.lang.String encoding)	Creates an XmlWriter to a file with a given encoding.

Method Summary

Modifier and Type	Method	Description
void	addAttribute(java.lang.String name, boolean value)	Adds a boolean attribute to current element.
void	addAttribute(java.lang.String name, byte value)	Adds a byte attribute to current element.
void	addAttribute(java.lang.String name, char value)	Adds a char attribute to current element.
void	addAttribute(java.lang.String name, double value)	Adds a double attribute to current element.
void	addAttribute(java.lang.String name, float value)	Adds a float attribute to current element.
void	addAttribute(java.lang.String name, int value)	Adds an int attribute to current element.
void	addAttribute(java.lang.String name, long value)	Adds a long attribute to current element.
void	addAttribute(java.lang.String name, short value)	Adds a short attribute to current element.
void	addAttribute(java.lang.String name, java.lang.Object value)	Adds an Object attribute to current element.
void	addAttribute(java.lang.String name, java.lang.String value)	Adds a String attribute to current element.
void	addCData(java.lang.String content)	Inserts a CData section with a content.
void	addCDataContent(java.lang.String content)	Adds content to current CData.
void	addComment(java.lang.String content)	Inserts a comment section with a content.
void	addCommentContent(java.lang.String content)	Adds content to current comment.
void	addDefaultNamespace(java.lang.String uri)
void	addElement(java.lang.String name, java.lang.String content)
void	addElementContent(java.lang.String content)
void	addElementIfNonEmpty(java.lang.String name, java.lang.String content)
void	addNamespace(java.lang.String prefix, java.lang.String uri)	Adds a namespace declaration.
void	addProcessingInstruction(java.lang.String target, java.lang.String content)
void	addProcessingInstructionContent(java.lang.String content)
void	addStyleSheet(java.lang.String xsl)	Helper function used to insert a StyleSheet Processing Instruction.
void	beginCData()	Starts the writing of a new CData.
void	beginComment()	Starts the writing of a new comment.
void	beginDocument()	Begins an XML document, using writer's encoding and version 1.0.
void	beginDocument(java.lang.String version)	Begins an XML document, using writer's encoding.
void	beginElement(java.lang.String name)
void	beginProcessingInstruction(java.lang.String target)
void	close()
protected static void	dataError(java.lang.String message)
void	endCData()	Closes the current CData.
void	endComment()	Closes the current comment.
void	endDocument()
void	endElement()
void	endProcessingInstruction()
void	flush()
CaseConverter	getConverter()	Returns the case converter.
java.lang.String	getEndOfLine()
java.lang.String	getIndentString()
boolean	isEnabled(XmlWriter.Feature feature)	Returns true if a feature is enabled, false otherwise.
void	reset()
XmlWriter	setEnabled(XmlWriter.Feature... features)
XmlWriter	setEnabled(XmlWriter.Feature feature, boolean enabled)	Enables or disables a feature.
void	setEndOfLine(java.lang.String eol)	Set the string to use for end of lines.
XmlWriter	setIndentString(java.lang.String s)	Set the indent string.
void	setTabSize(int tabSize)

Methods inherited from class java.lang.Object

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

Field Detail

CDATA_END_PATTERN

protected static final java.util.regex.Pattern CDATA_END_PATTERN

LF

public static final java.lang.String LF

See Also:

Constant Field Values

CR

public static final java.lang.String CR

See Also:

Constant Field Values

TAB

public static final java.lang.String TAB

See Also:

Constant Field Values

GT

public static final java.lang.String GT

See Also:

Constant Field Values

LT

public static final java.lang.String LT

See Also:

Constant Field Values

QUOT

public static final java.lang.String QUOT

See Also:

Constant Field Values

APOS

public static final java.lang.String APOS

See Also:

Constant Field Values

AMP

public static final java.lang.String AMP

See Also:

Constant Field Values

Constructor Detail

XmlWriter

public XmlWriter(java.io.Writer writer,
                 java.lang.String encoding)

Creates an XmlWriter to a Writer with a given encoding.

Parameters:

writer - The writer.

encoding - The encoding to use.

XmlWriter

public XmlWriter(java.io.Writer writer)

Creates an XmlWriter to a Writer, with UTF-8 encoding.

Parameters:

writer - The writer.

XmlWriter

public XmlWriter()
          throws java.io.UnsupportedEncodingException

Creates an XmlWriter to System.out, with UTF-8 encoding.

Throws:

java.io.UnsupportedEncodingException - If UTF-8 is not supported, which should not happen.

XmlWriter

public XmlWriter(java.io.PrintStream out)
          throws java.io.UnsupportedEncodingException

Creates an XmlWriter to a PrintStream, with UTF-8 encoding.

Parameters:

out - The PrintStream to use. Must be closed be the caller.

Throws:

java.io.UnsupportedEncodingException - If UTF-8 encoding is not supported, which should not happen.

XmlWriter

public XmlWriter(java.io.OutputStream os,
                 java.lang.String encoding)
          throws java.io.UnsupportedEncodingException

Creates an XmlWriter to an OutputStream with a given encoding.

Parameters:

os - The outputStream. Must be closed by caller.

encoding - The encoding to use.

Throws:

java.io.UnsupportedEncodingException - If the named encoding is not supported.

XmlWriter

public XmlWriter(java.io.OutputStream os)
          throws java.io.UnsupportedEncodingException

Creates an XmlWriter to an OutputStream with UTF-8 encoding.

Parameters:

os - The outputStream. Must be closed by caller.

Throws:

java.io.UnsupportedEncodingException - If the named encoding is not supported.

XmlWriter

public XmlWriter(java.lang.String filename,
                 java.lang.String encoding)
          throws java.io.FileNotFoundException,
                 java.io.UnsupportedEncodingException

Creates an XmlWriter to a file with a given encoding.

Parameters:

filename - Name of the file.

encoding - The encoding to use.

Throws:

java.io.FileNotFoundException - If the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason.

java.io.UnsupportedEncodingException - If the named encoding is not supported.

XmlWriter

public XmlWriter(java.lang.String filename)
          throws java.io.FileNotFoundException,
                 java.io.UnsupportedEncodingException

Creates an XmlWriter to a file with UTF-8 encoding.

Parameters:

filename - Name of the file.

Throws:

java.io.FileNotFoundException - If the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason.

java.io.UnsupportedEncodingException - If the named encoding is not supported.

XmlWriter

public XmlWriter(java.io.File file,
                 java.lang.String encoding)
          throws java.io.FileNotFoundException,
                 java.io.UnsupportedEncodingException

Creates an XmlWriter to a file with a given encoding.

Parameters:

file - File to use.

encoding - The encoding to use.

Throws:

java.io.FileNotFoundException - If the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason.

java.io.UnsupportedEncodingException - If the named encoding is not supported.

XmlWriter

public XmlWriter(java.io.File file)
          throws java.io.FileNotFoundException,
                 java.io.UnsupportedEncodingException

Creates an XmlWriter to a file using UTF-8 encoding.

Parameters:

file - File to use.

Throws:

java.io.FileNotFoundException - If the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason.

java.io.UnsupportedEncodingException - If UTF-8 encoding is not supported, which should not happen.

Method Detail

dataError

protected static void dataError(java.lang.String message)

setEnabled

public final XmlWriter setEnabled(XmlWriter.Feature feature,
                                  boolean enabled)

Enables or disables a feature.

Parameters:

feature - The feature to enable/disable.

enabled - If true, enable the feature.

Returns:

This writer.

setEnabled

public final XmlWriter setEnabled(XmlWriter.Feature... features)

isEnabled

public final boolean isEnabled(XmlWriter.Feature feature)

Returns true if a feature is enabled, false otherwise.

Parameters:

feature - The feature.

Returns:

true if feature is enabled, false otherwise.

setIndentString

public final XmlWriter setIndentString(java.lang.String s)

Set the indent string.

Parameters:

s - The indent string.

Returns:

This writer.

getIndentString

public final java.lang.String getIndentString()

setTabSize

public final void setTabSize(int tabSize)

setEndOfLine

public final void setEndOfLine(java.lang.String eol)

Set the string to use for end of lines.

This may be useful to force an OS specific symbol.
This has interactions with XmlWriter.Feature.USE_XML_EOL.
WARNING: It is the responsibility of programmer to use a valid string.

Parameters:

eol - The end of line string.

getEndOfLine

public final java.lang.String getEndOfLine()

Returns:

The end of line string.

getConverter

public final CaseConverter getConverter()

Returns the case converter. Used if USE_CONVERTER feature is enabled.

Returns:

The case converter.

beginDocument

public final void beginDocument(java.lang.String version)
                         throws java.io.IOException

Begins an XML document, using writer's encoding.

Parameters:

version - The XML version to use.

Throws:

java.io.IOException - If an I/O error occurs.

beginDocument

public final void beginDocument()
                         throws java.io.IOException

Begins an XML document, using writer's encoding and version 1.0.

Throws:

java.io.IOException - If an I/O error occurs.

beginProcessingInstruction

public final void beginProcessingInstruction(java.lang.String target)
                                      throws java.io.IOException

Throws:

java.io.IOException

addProcessingInstructionContent

public final void addProcessingInstructionContent(java.lang.String content)
                                           throws java.io.IOException

Throws:

java.io.IOException

endProcessingInstruction

public final void endProcessingInstruction()
                                    throws java.io.IOException

Throws:

java.io.IOException

addProcessingInstruction

public final void addProcessingInstruction(java.lang.String target,
                                           java.lang.String content)
                                    throws java.io.IOException

Throws:

java.io.IOException

addStyleSheet

public final void addStyleSheet(java.lang.String xsl)
                         throws java.io.IOException

Helper function used to insert a StyleSheet Processing Instruction.

Parameters:

xsl - The URL of the style sheet to use.

Throws:

java.io.IOException - If an I/O error occurs.

beginComment

public final void beginComment()
                        throws java.io.IOException

Starts the writing of a new comment.

Throws:

java.io.IOException - If an I/O error occurs.

addCommentContent

public final void addCommentContent(java.lang.String content)

Adds content to current comment.

Parameters:

content - The text to add to current comment.

endComment

public final void endComment()
                      throws java.io.IOException

Closes the current comment.

Throws:

java.io.IOException - If an I/O error occurs.

addComment

public final void addComment(java.lang.String content)
                      throws java.io.IOException

Inserts a comment section with a content.

Parameters:

content - The comment content.

Throws:

java.io.IOException - If an I/O error occurs.

beginCData

public final void beginCData()
                      throws java.io.IOException

Starts the writing of a new CData.

Throws:

java.io.IOException - If an I/O error occurs.

addCDataContent

public final void addCDataContent(java.lang.String content)

Adds content to current CData.

Parameters:

content - The text to add to current CData.

endCData

public final void endCData()
                    throws java.io.IOException

Closes the current CData.

Throws:

java.io.IOException - If an I/O error occurs.

addCData

public final void addCData(java.lang.String content)
                    throws java.io.IOException

Inserts a CData section with a content.

Parameters:

content - The CData content.

Throws:

java.io.IOException - If an I/O error occurs.

beginElement

public final void beginElement(java.lang.String name)
                        throws java.io.IOException

Throws:

java.io.IOException

addAttribute

public final void addAttribute(java.lang.String name,
                               java.lang.Object value)
                        throws java.io.IOException

Adds an Object attribute to current element.

If object is null adds an empty attribute.
Otherwise, uses toString() to convert value to a String.

Parameters:

name - Attribute name.

value - Attribute value.

Throws:

java.io.IOException - If an I/O error occurs.

addAttribute

public final void addAttribute(java.lang.String name,
                               java.lang.String value)
                        throws java.io.IOException

Adds a String attribute to current element.

Parameters:

name - Attribute name.

value - Attribute value.

Throws:

java.io.IOException - If an I/O error occurs.

addAttribute

public final void addAttribute(java.lang.String name,
                               char value)
                        throws java.io.IOException

Adds a char attribute to current element.

Parameters:

name - Attribute name.

value - Attribute value.

Throws:

java.io.IOException - If an I/O error occurs.

addAttribute

public final void addAttribute(java.lang.String name,
                               boolean value)
                        throws java.io.IOException

Adds a boolean attribute to current element.

Parameters:

name - Attribute name.

value - Attribute value.

Throws:

java.io.IOException - If an I/O error occurs.

addAttribute

public final void addAttribute(java.lang.String name,
                               long value)
                        throws java.io.IOException

Adds a long attribute to current element.

Parameters:

name - Attribute name.

value - Attribute value.

Throws:

java.io.IOException - If an I/O error occurs.

addAttribute

public final void addAttribute(java.lang.String name,
                               int value)
                        throws java.io.IOException

Adds an int attribute to current element.

Parameters:

name - Attribute name.

value - Attribute value.

Throws:

java.io.IOException - If an I/O error occurs.

addAttribute

public final void addAttribute(java.lang.String name,
                               short value)
                        throws java.io.IOException

Adds a short attribute to current element.

Parameters:

name - Attribute name.

value - Attribute value.

Throws:

java.io.IOException - If an I/O error occurs.

addAttribute

public final void addAttribute(java.lang.String name,
                               byte value)
                        throws java.io.IOException

Adds a byte attribute to current element.

Parameters:

name - Attribute name.

value - Attribute value.

Throws:

java.io.IOException - If an I/O error occurs.

addAttribute

public final void addAttribute(java.lang.String name,
                               double value)
                        throws java.io.IOException

Adds a double attribute to current element.

Parameters:

name - Attribute name.

value - Attribute value.

Throws:

java.io.IOException - If an I/O error occurs.

addAttribute

public final void addAttribute(java.lang.String name,
                               float value)
                        throws java.io.IOException

Adds a float attribute to current element.

Parameters:

name - Attribute name.

value - Attribute value.

Throws:

java.io.IOException - If an I/O error occurs.

addNamespace

public final void addNamespace(java.lang.String prefix,
                               java.lang.String uri)
                        throws java.io.IOException

Adds a namespace declaration.

Parameters:

prefix - Namespace prefix

uri - Associated URI.

Throws:

java.io.IOException - If an I/O error occurs.

addDefaultNamespace

public final void addDefaultNamespace(java.lang.String uri)
                               throws java.io.IOException

Throws:

java.io.IOException

addElementContent

public final void addElementContent(java.lang.String content)
                             throws java.io.IOException

Throws:

java.io.IOException

endElement

public final void endElement()
                      throws java.io.IOException

Throws:

java.io.IOException

addElement

public final void addElement(java.lang.String name,
                             java.lang.String content)
                      throws java.io.IOException

Throws:

java.io.IOException

addElementIfNonEmpty

public final void addElementIfNonEmpty(java.lang.String name,
                                       java.lang.String content)
                                throws java.io.IOException

Throws:

java.io.IOException

endDocument

public final void endDocument()
                       throws java.io.IOException

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Specified by:

flush in interface java.io.Flushable

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Throws:

java.io.IOException

reset

public void reset()