org.json.util

Class Latin1AppendableOutputStream

java.lang.Object

java.io.OutputStream

org.json.util.Latin1AppendableOutputStream

All Implemented Interfaces:

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

public final class Latin1AppendableOutputStream
extends java.io.OutputStream

Adapts an java.io.OutputStream of Latin1 bytes onto an Appendable sink. A modest buffer is used to batch up append operations.

In addition, the Appendable to be buffered is supplied using the with(Appendable) method, rather than at construction time. This allows the buffer to be reused for several different operations requiring buffering.

Uses java.nio.CharBuffer.allocate() to create the backing buffer.

Does not propagate the flush() or close() methods to the wrapped Appendable.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_BUFFER_SIZE The default buffer size of 1024 characters, if none is specified.

Constructor Summary

Constructors

Constructor and Description
Latin1AppendableOutputStream() Adapt a given Appendable with the default buffer size.
Latin1AppendableOutputStream(int buffSize) Adapt a given Appendable with the given buffer size.

Method Summary

Modifier and Type	Method and Description
void	close() Flush and close the buffer of this Latin1AppendableOutputStream.
void	flush() Flush the buffer of this Latin1AppendableOutputStream.
Latin1AppendableOutputStream	with(java.lang.Appendable newAppendable) Reset this latin1 appendable, setting it to buffer the given appendable.
void	write(byte[] b, int off, int len) Writes len bytes from the specified byte array starting at offset off to the underlying Appendable as Latin1 characters.
void	write(int b) Writes the specified byte to the underlying Appendable as a Latin1 character.

Methods inherited from class java.io.OutputStream

write

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE

The default buffer size of 1024 characters, if none is specified.

See Also:

Constant Field Values

Constructor Detail

Latin1AppendableOutputStream

public Latin1AppendableOutputStream()

Adapt a given Appendable with the default buffer size.

Latin1AppendableOutputStream

public Latin1AppendableOutputStream(int buffSize)

Adapt a given Appendable with the given buffer size. The size must be at least 16.

Parameters:

buffSize - the buffer size, must be >= 16

Throws:

java.lang.NullPointerException - the supplied Appendable is null

Method Detail

with

public Latin1AppendableOutputStream with(java.lang.Appendable newAppendable)

Reset this latin1 appendable, setting it to buffer the given appendable. Any existing buffered output is flushed to the old Appendable first.

This resets the state of the buffered reader to the open state if the new appendable is non-null, otherwise resets the state to closed.

Parameters:

newAppendable - the new Appendable to buffer

Returns:

this Latin1AppendableOutputStream

write

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

Writes the specified byte to the underlying Appendable as a Latin1 character.

Specified by:

write in class java.io.OutputStream

Parameters:

b - the byte.

Throws:

java.io.IOException - if an I/O error occurs. In particular, an IOException may be thrown if the underlying Appendable has been closed.

write

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

Writes len bytes from the specified byte array starting at offset off to the underlying Appendable as Latin1 characters.

If b is null, a NullPointerException is thrown.

If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown.

Overrides:

write in class java.io.OutputStream

Parameters:

b - the data.

off - the start offset in the data.

len - the number of bytes to write.

Throws:

java.io.IOException - if an I/O error occurs. In particular, an IOException is thrown if the underlying Appendable is closed.

flush

public void flush()
           throws java.io.IOException

Flush the buffer of this Latin1AppendableOutputStream.

Specified by:

flush in interface java.io.Flushable

Overrides:

flush in class java.io.OutputStream

Throws:

java.io.IOException - there was a problem appending to the underlying Appendable

close

public void close()
           throws java.io.IOException

Flush and close the buffer of this Latin1AppendableOutputStream.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.io.OutputStream

Throws:

java.io.IOException - there was a problem appending to the underlying Appendable