com.sun.xml.stream.writers

Class XMLWriter

java.lang.Object

java.io.Writer

com.sun.xml.stream.writers.XMLWriter

All Implemented Interfaces:

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

public class XMLWriter
extends java.io.Writer

XMLWriter. XMLWriter is not thread safe. For efficiency this writer buffers the input. Use flush() function to explicitly write the data to underlying stream. This writer is designed in such a way that it atleast buffers the input to the size specified. Unless flush is called, it guarantees that data in chunks of size equal to or more than size specified will be written. XMLWriter instance can be reused. setWriter() internally clears the buffer and stores the reference to newly supplied Writer instance.

Author:

Neeraj Bajaj Sun Microsystems, inc., Sunitha Reddy Sun Microsystems, inc.

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
XMLWriter(java.io.Writer writer) Creates the instance of XMLWriter
XMLWriter(java.io.Writer writer, int size) Creates the instnace of XMLWriter.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the stream, flushing it first.
void	flush() Flush the stream.
protected java.io.Writer	getWriter() Returns underlying Writer
void	reset() Reset this Writer.
void	setWriter(java.io.Writer writer) Set the given Writer.
void	setWriter(java.io.Writer writer, int size) Set the given Writer
void	write(char[] cbuf) Write an array of characters.
void	write(char[] cbuf, int off, int len) Write a portion of an array of characters.
void	write(int c) Write a single character.
void	write(java.lang.String str) Write a string.
void	write(java.lang.String str, int off, int len) Write a portion of a string.

Methods inherited from class java.io.Writer

append, append, append

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLWriter

public XMLWriter(java.io.Writer writer)

Creates the instance of XMLWriter

XMLWriter

public XMLWriter(java.io.Writer writer,
         int size)

Creates the instnace of XMLWriter. atleast buffers the input to the size specified.

Method Detail

write

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

Write a single character. The character to be written is contained in the 16 low-order bits of the given integer value; the 16 high-order bits are ignored.

Subclasses that intend to support efficient single-character output should override this method.

Overrides:

write in class java.io.Writer

Parameters:

c - int specifying a character to be written.

Throws:

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

write

public void write(char[] cbuf)
           throws java.io.IOException

Write an array of characters.

Overrides:

write in class java.io.Writer

Parameters:

cbuf - Array of characters to be written

Throws:

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

write

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

Write a portion of an array of characters.

Specified by:

write in class java.io.Writer

Parameters:

cbuf - Array of characters

off - Offset from which to start writing characters

len - Number of characters to write

Throws:

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

write

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

Write a portion of a string.

Overrides:

write in class java.io.Writer

Parameters:

str - A String

off - Offset from which to start writing characters

len - Number of characters to write

Throws:

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

write

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

Write a string.

Overrides:

write in class java.io.Writer

Parameters:

str - String to be written

Throws:

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

close

public void close()
           throws java.io.IOException

Close the stream, flushing it first. Once a stream has been closed, further write() or flush() invocations will cause an IOException to be thrown. Closing a previously-closed stream, however, has no effect.

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 - If an I/O error occurs

flush

public void flush()
           throws java.io.IOException

Flush the stream. If the stream has saved any characters from the various write() methods in a buffer, write them immediately to their intended destination. Then, if that destination is another character or byte stream, flush it. Thus one flush() invocation will flush all the buffers in a chain of Writers and OutputStreams.

Specified by:

flush in interface java.io.Flushable

Specified by:

flush in class java.io.Writer

Throws:

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

reset

public void reset()

Reset this Writer. see @setWriter()

setWriter

public void setWriter(java.io.Writer writer)

Set the given Writer.

Parameters:

Writer - Writer.

setWriter

public void setWriter(java.io.Writer writer,
             int size)

Set the given Writer

Parameters:

Writer - Writer.

int - Writer will buffer the character data size, after that data is written to stream.

getWriter

protected java.io.Writer getWriter()

Returns underlying Writer