org.ka2ddo.util

Class UTF8StreamWriter

java.lang.Object

java.io.Writer

org.ka2ddo.util.UTF8StreamWriter

All Implemented Interfaces:

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

public class UTF8StreamWriter
extends java.io.Writer

This class implements a memory-optimized optimized writer-to-stream conversion assuming only UTF-8. It is recommended that a NonshareableBufferedOutputStream be used below this class due to the large number of calls to the encapsulated OutputStream's write(int) method.

Author:

Andrew Pavlin, KA2DDO

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor and Description
UTF8StreamWriter(java.io.OutputStream out) Create a UTF8StreamWriter around the specified OutputStream.

Method Summary

Modifier and Type	Method and Description
java.io.Writer	append(char c) Appends the specified character to this writer.
void	close() Closes the stream, flushing it first.
void	flush() Flushes the stream.
void	write(char[] cbuf, int off, int len) Writes a portion of an array of characters.
void	write(int c) Writes a single character.
void	write(java.lang.String str, int off, int len) Writes a portion of a string.

Methods inherited from class java.io.Writer

append, append, write, write

Methods inherited from class java.lang.Object

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

Constructor Detail

UTF8StreamWriter

public UTF8StreamWriter(java.io.OutputStream out)

Create a UTF8StreamWriter around the specified OutputStream.

Parameters:

out - OutputStream to feed UTF-8 encoded data

Method Detail

write

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

Writes 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.

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

append

public java.io.Writer append(char c)
                      throws java.io.IOException

Appends the specified character to this writer.

An invocation of this method of the form out.append(c) behaves in exactly the same way as the invocation

     out.write(c) 

Specified by:

append in interface java.lang.Appendable

Overrides:

append in class java.io.Writer

Parameters:

c - The 16-bit character to append

Returns:

This writer

Throws:

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

Since:

1.5

write

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

Writes 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

Writes 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.lang.IndexOutOfBoundsException - If off is negative, or len is negative, or off+len is negative or greater than the length of the given string

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

flush

public void flush()
           throws java.io.IOException

Flushes 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

close

public void close()
           throws java.io.IOException

Closes the stream, flushing it first. Once the stream has been closed, further write() or flush() invocations will cause an IOException to be thrown. Closing a previously closed stream 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