org.apache.xml.serializer
Class WriterToUTF8Buffered

java.lang.Object
  |
  +--java.io.Writer
        |
        +--org.apache.xml.serializer.WriterToUTF8Buffered

public final class WriterToUTF8Buffered

extends java.io.Writer

This class writes unicode characters to a byte stream (java.io.OutputStream) as quickly as possible. It buffers the output in an internal buffer which must be flushed to the OutputStream when done. This flushing is done via the close() flush() or flushBuffer() method.

Constructor Summary

WriterToUTF8Buffered(java.io.OutputStream out)
Create an buffered UTF-8 writer.

Method Summary

void	close() Close the stream, flushing it first.
void	directWrite(java.lang.String s)
void	flush() Flush the stream.
void	flushBuffer() Flush the internal buffer
java.io.OutputStream	getOutputStream() Get the output stream where the events will be serialized to.
void	write(char[] chars, int start, int length) Write a portion of an array of characters.
void	write(int c) Write a single character.
void	write(java.lang.String s) Write a string.

Methods inherited from class java.io.Writer

write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

WriterToUTF8Buffered

public WriterToUTF8Buffered(java.io.OutputStream out)
                     throws java.io.UnsupportedEncodingException

Create an buffered UTF-8 writer.

Parameters:

out - the underlying output stream.

Throws:

java.io.UnsupportedEncodingException -

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.

Parameters:

c - int specifying a character to be written.

Throws:

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

Overrides:

write in class java.io.Writer

write

public void write(char[] chars,
                  int start,
                  int length)
           throws java.io.IOException

Write a portion of an array of characters.

Parameters:

chars - Array of characters

start - Offset from which to start writing characters

length - Number of characters to write

Throws:

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

java.io.IOException -

Overrides:

write in class java.io.Writer

write

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

Write a string.

Parameters:

s - String to be written

Throws:

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

Overrides:

write in class java.io.Writer

flushBuffer

public void flushBuffer()
                 throws java.io.IOException

Flush the internal buffer

Throws:

java.io.IOException -

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.

Throws:

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

java.io.IOException -

Overrides:

flush in class java.io.Writer

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.

Throws:

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

java.io.IOException -

Overrides:

close in class java.io.Writer

getOutputStream

public java.io.OutputStream getOutputStream()

Get the output stream where the events will be serialized to.

Returns:

reference to the result stream, or null of only a writer was set.

directWrite

public void directWrite(java.lang.String s)
                 throws java.io.IOException

Parameters:

s - A string with only ASCII characters

Throws:

java.io.IOException -