com.jclark.xml.output

Class UTF8XMLWriter

java.lang.Object

java.io.Writer

com.jclark.xml.output.XMLWriter

com.jclark.xml.output.UTF8XMLWriter

All Implemented Interfaces:

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

public class UTF8XMLWriter
extends XMLWriter

An XMLWriter that encodes characters in UTF-8. Methods are not synchronized: wrap this in a SyncXMLWriter if you need to use this concurrently from multiple threads.

Version:

$Revision: 1.1 $ $Date: 2000/01/26 04:31:49 $

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	UTF8XMLWriter.ReplacementTextOutputStream

Field Summary

Fields

Modifier and Type	Field and Description
private byte[]	buf
private int	bufUsed
private static int	DEFAULT_BUF_LENGTH
private static int	DEFAULT_OPTIONS
private boolean	inStartTag
private java.lang.String	lineSeparator
static int	MINIMIZE_EMPTY_ELEMENTS
static int	MINIMIZE_EMPTY_ELEMENTS_HTML
private boolean	minimizeEmptyElements
private boolean	minimizeEmptyElementsHtml
private java.io.OutputStream	out
private boolean	quoteWhitespace
private java.lang.String	sysLineSeparator

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
UTF8XMLWriter(java.io.OutputStream out) Create an XML writer that will write in UTF-8 to the specified OutputStream with the default options.
UTF8XMLWriter(java.io.OutputStream out, int options) Create an XML writer that will write in UTF-8 to the specified OutputStream with the specified options.

Method Summary

Methods

Modifier and Type	Method and Description
void	attribute(java.lang.String name, java.lang.String value) Writes an attribute.
void	cdataSection(java.lang.String content) Writes a CDATA section.
void	characterReference(int n) Writes a character reference.
void	close()
void	comment(java.lang.String body) Writes a comment.
void	endAttribute() Ends an attribute.
void	endElement(java.lang.String name) Ends an element.
void	endReplacementText() Ends the replacement text for an internal entity.
void	entityReference(boolean isParam, java.lang.String name) Writes an entity reference.
private void	finishStartTag()
void	flush()
private void	flushBuf()
void	markup(java.lang.String str) Writes markup.
void	processingInstruction(java.lang.String target, java.lang.String data) Writes a processing instruction.
private void	put(byte b)
void	startAttribute(java.lang.String name) Starts an attribute.
void	startElement(java.lang.String name) Starts an element.
void	startReplacementText() Starts the replacement text for an internal entity.
void	write(char c)
void	write(char[] cbuf, int off, int len)
void	write(java.lang.String str)
void	write(java.lang.String str, int off, int len)
private void	writeMarkup(java.lang.String str)
private void	writeMB(char c)
private void	writeQuote(char c)
private void	writeQuote(java.lang.String str, int off, int len)
private void	writeRaw(java.lang.String str)
private void	writeSurrogatePair(char c1, char c2)
void	writeUTF8(byte[] buf, int off, int len)

Methods inherited from class java.io.Writer

append, append, append, write, write

Methods inherited from class java.lang.Object

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

Field Detail

out

private java.io.OutputStream out

inStartTag

private boolean inStartTag

quoteWhitespace

private boolean quoteWhitespace

DEFAULT_BUF_LENGTH

private static final int DEFAULT_BUF_LENGTH

See Also:

Constant Field Values

buf

private byte[] buf

bufUsed

private int bufUsed

sysLineSeparator

private java.lang.String sysLineSeparator

lineSeparator

private java.lang.String lineSeparator

minimizeEmptyElements

private boolean minimizeEmptyElements

minimizeEmptyElementsHtml

private boolean minimizeEmptyElementsHtml

MINIMIZE_EMPTY_ELEMENTS

public static final int MINIMIZE_EMPTY_ELEMENTS

See Also:

Constant Field Values

MINIMIZE_EMPTY_ELEMENTS_HTML

public static final int MINIMIZE_EMPTY_ELEMENTS_HTML

See Also:

Constant Field Values

DEFAULT_OPTIONS

private static final int DEFAULT_OPTIONS

See Also:

Constant Field Values

Constructor Detail

UTF8XMLWriter

public UTF8XMLWriter(java.io.OutputStream out,
             int options)

Create an XML writer that will write in UTF-8 to the specified OutputStream with the specified options.

UTF8XMLWriter

public UTF8XMLWriter(java.io.OutputStream out)

Create an XML writer that will write in UTF-8 to the specified OutputStream with the default options.

Method Detail

writeUTF8

public void writeUTF8(byte[] buf,
             int off,
             int len)
               throws java.io.IOException

Throws:

java.io.IOException

write

public void write(char[] cbuf,
         int off,
         int len)
           throws java.io.IOException

Specified by:

write in class java.io.Writer

Throws:

java.io.IOException

write

public void write(char c)
           throws java.io.IOException

Throws:

java.io.IOException

write

public void write(java.lang.String str)
           throws java.io.IOException

Overrides:

write in class java.io.Writer

Throws:

java.io.IOException

write

public void write(java.lang.String str,
         int off,
         int len)
           throws java.io.IOException

Overrides:

write in class java.io.Writer

Throws:

java.io.IOException

writeQuote

private final void writeQuote(java.lang.String str,
              int off,
              int len)
                       throws java.io.IOException

Throws:

java.io.IOException

writeQuote

private final void writeQuote(char c)
                       throws java.io.IOException

Throws:

java.io.IOException

writeRaw

private void writeRaw(java.lang.String str)
               throws java.io.IOException

Throws:

java.io.IOException

writeMB

private final void writeMB(char c)
                    throws java.io.IOException

Throws:

java.io.IOException

writeSurrogatePair

private final void writeSurrogatePair(char c1,
                      char c2)
                               throws java.io.IOException

Throws:

java.io.IOException

startElement

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

Description copied from class: XMLWriter

Starts an element. This may be followed by zero or more calls to attribute. The start-tag will be closed by the first following call to any method other than attribute.

Specified by:

startElement in class XMLWriter

Throws:

java.io.IOException

finishStartTag

private void finishStartTag()
                     throws java.io.IOException

Throws:

java.io.IOException

attribute

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

Description copied from class: XMLWriter

Writes an attribute. This is not legal if there have been calls to methods other than attribute since the last call to startElement, unless inside a startAttribute, endAttribute pair.

Specified by:

attribute in class XMLWriter

Throws:

java.io.IOException

startAttribute

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

Description copied from class: XMLWriter

Starts an attribute. This writes the attribute name, = and the opening quote. This provides an alternative to attribute that allows markup to be included in the attribute value. The value of the attribute is written using the normal write methods; endAttribute must be called at the end of the attribute value. Entity and character references can be written using entityReference and characterReference.

Specified by:

startAttribute in class XMLWriter

Throws:

java.io.IOException

endAttribute

public void endAttribute()
                  throws java.io.IOException

Description copied from class: XMLWriter

Ends an attribute. This writes the closing quote of the attribute value.

Specified by:

endAttribute in class XMLWriter

Throws:

java.io.IOException

endElement

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

Description copied from class: XMLWriter

Ends an element. This may output an end-tag or close the current start-tag as an empty element.

Specified by:

endElement in class XMLWriter

Throws:

java.io.IOException

processingInstruction

public void processingInstruction(java.lang.String target,
                         java.lang.String data)
                           throws java.io.IOException

Description copied from class: XMLWriter

Writes a processing instruction. If data is non-empty a space will be inserted automatically to separate it from the target.

Specified by:

processingInstruction in class XMLWriter

Throws:

java.io.IOException

comment

public void comment(java.lang.String body)
             throws java.io.IOException

Description copied from class: XMLWriter

Writes a comment.

Specified by:

comment in class XMLWriter

Throws:

java.io.IOException

entityReference

public void entityReference(boolean isParam,
                   java.lang.String name)
                     throws java.io.IOException

Description copied from class: XMLWriter

Writes an entity reference.

Specified by:

entityReference in class XMLWriter

Throws:

java.io.IOException

characterReference

public void characterReference(int n)
                        throws java.io.IOException

Description copied from class: XMLWriter

Writes a character reference.

Specified by:

characterReference in class XMLWriter

Throws:

java.io.IOException

cdataSection

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

Description copied from class: XMLWriter

Writes a CDATA section.

Specified by:

cdataSection in class XMLWriter

Throws:

java.io.IOException

markup

public void markup(java.lang.String str)
            throws java.io.IOException

Description copied from class: XMLWriter

Writes markup. The characters in the string will be written as is without being escaped (except for any escaping enabled by startReplacementText).

Specified by:

markup in class XMLWriter

Throws:

java.io.IOException

startReplacementText

public void startReplacementText()
                          throws java.io.IOException

Description copied from class: XMLWriter

Starts the replacement text for an internal entity. The replacement text must be ended with endReplacementText. This enables an extra level of escaping that protects against the process of constructing an entity's replacement text from the literal entity value. See Section 4.5 of the XML Recommendation. Between a call to startReplacementText and endReplacementText, the argument to markup would specify entity replacement text; these would be escaped so that when processed as a literal entity value, the specified entity replacement text would be constructed. This call does not itself cause anything to be written.

Specified by:

startReplacementText in class XMLWriter

Throws:

java.io.IOException

endReplacementText

public void endReplacementText()
                        throws java.io.IOException

Description copied from class: XMLWriter

Ends the replacement text for an internal entity. This disables the extra level of escaping enabled by startReplacementText. This call does not itself cause anything to be written.

Specified by:

endReplacementText in class XMLWriter

Throws:

java.io.IOException

writeMarkup

private void writeMarkup(java.lang.String str)
                  throws java.io.IOException

Throws:

java.io.IOException

put

private final void put(byte b)
                throws java.io.IOException

Throws:

java.io.IOException

flushBuf

private final void flushBuf()
                     throws java.io.IOException

Throws:

java.io.IOException

flush

public void flush()
           throws java.io.IOException

Specified by:

flush in interface java.io.Flushable

Specified by:

flush in class java.io.Writer

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in class java.io.Writer

Throws:

java.io.IOException