org.json.util

Class BufferedAppendable

java.lang.Object

java.io.Writer

org.json.util.BufferedAppendable

All Implemented Interfaces:

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

public final class BufferedAppendable
extends java.io.Writer

A simple buffering Appendable, without the synchronization of java.io.BufferedWriter. This means that all operations on a BufferedAppendable object must be performed synchronously.

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.

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
BufferedAppendable	append(char c) Appends the specified character to this BufferedAppendable.
BufferedAppendable	append(java.lang.CharSequence csq) Appends the specified character sequence to this BufferedAppendable.
BufferedAppendable	append(java.lang.CharSequence csq, int start, int end) Appends a subsequence of the specified character sequence to this BufferedAppendable.
void	close() Flush and close the buffer of this BufferedAppendable.
void	flush() Flush the buffer of this BufferedAppendable.
BufferedAppendable	with(java.lang.Appendable newAppendable) Reset this buffered appendable, setting it to buffer the given appendable.
void	write(char[] cbuf) Writes an array of characters.
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) Writes a string.
void	write(java.lang.String str, int off, int len) Writes a portion of a string.

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

BufferedAppendable

public BufferedAppendable()

Buffer a given Appendable with the default buffer size.

BufferedAppendable

public BufferedAppendable(int buffSize)

Buffer 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 BufferedAppendable with(java.lang.Appendable newAppendable)

Reset this buffered 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 BufferedAppendable

append

public BufferedAppendable append(java.lang.CharSequence csq)
                          throws java.io.IOException

Appends the specified character sequence to this BufferedAppendable.

Specified by:

append in interface java.lang.Appendable

Overrides:

append in class java.io.Writer

Parameters:

csq - the character sequence to be appended

Returns:

this BufferedAppendable

Throws:

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

append

public BufferedAppendable append(java.lang.CharSequence csq,
                                 int start,
                                 int end)
                          throws java.io.IOException

Appends a subsequence of the specified character sequence to this BufferedAppendable.

Specified by:

append in interface java.lang.Appendable

Overrides:

append in class java.io.Writer

Parameters:

csq - The character sequence from which a subsequence will be appended.

start - The index of the first character in the subsequence

end - The index of the character following the last character in the subsequence

Returns:

this BufferedAppendable

Throws:

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

append

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

Appends the specified character to this BufferedAppendable.

Specified by:

append in interface java.lang.Appendable

Overrides:

append in class java.io.Writer

Parameters:

c - The character to append

Returns:

this BufferedAppendable

Throws:

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

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

write

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

Writes 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

java.lang.NullPointerException - cbuf is null

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

java.lang.NullPointerException - cbuf is null

java.lang.IndexOutOfBoundsException - off or len are out of bounds

write

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

Writes 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

java.lang.NullPointerException - str is null

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

java.lang.NullPointerException - str is null

flush

public void flush()
           throws java.io.IOException

Flush the buffer of this BufferedAppendable.

Specified by:

flush in interface java.io.Flushable

Specified by:

flush in class java.io.Writer

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

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 - there was a problem appending to the underlying Appendable