Module com.aoapps.io.buffer

Package com.aoapps.io.buffer

Class SegmentedWriter

java.lang.Object

java.io.Writer

com.aoapps.io.buffer.BufferWriter

com.aoapps.io.buffer.SegmentedWriter

All Implemented Interfaces:

Closeable, Flushable, Appendable, AutoCloseable

public class SegmentedWriter
extends BufferWriter

Buffers all writes in segments. This is to hold references to strings instead of copying all the characters.

This class is not thread safe.

Future: If writing to another segmented buffer, the segments could be shared between the two instances. (or arraycopy instead of writing each)

Author:

AO Industries, Inc.

Field Summary

Fields inherited from class java.io.Writer

lock

Constructor Summary

Constructors

Constructor	Description
SegmentedWriter()

Method Summary

Modifier and Type	Method	Description
SegmentedWriter	append(char c)
SegmentedWriter	append(CharSequence csq)
SegmentedWriter	append(CharSequence csq, int start, int end)
void	close()
void	flush()
long	getLength()	Gets the number of characters in this buffer.
BufferResult	getResult()	Gets the result from this buffer.
String	toString()	Gets a short message (like type and length).
void	write(char[] cbuf)
void	write(char[] cbuf, int off, int len)
void	write(int c)
void	write(String str)
void	write(String str, int off, int len)

Methods inherited from class java.io.Writer

nullWriter

Methods inherited from class java.lang.Object

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

Constructor Details

SegmentedWriter

public SegmentedWriter()

Method Details

write

public void write(int c)
           throws ClosedChannelException

Overrides:

write in class Writer

Throws:

ClosedChannelException

write

public void write(char[] cbuf)
           throws ClosedChannelException

Overrides:

write in class Writer

Throws:

ClosedChannelException

write

public void write(char[] cbuf,
 int off,
 int len)
           throws ClosedChannelException

Specified by:

write in class Writer

Throws:

ClosedChannelException

write

public void write(String str)
           throws ClosedChannelException

Overrides:

write in class Writer

Throws:

ClosedChannelException

write

public void write(String str,
 int off,
 int len)
           throws ClosedChannelException

Overrides:

write in class Writer

Throws:

ClosedChannelException

append

public SegmentedWriter append(CharSequence csq)
                       throws ClosedChannelException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

ClosedChannelException

append

public SegmentedWriter append(CharSequence csq,
 int start,
 int end)
                       throws ClosedChannelException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

ClosedChannelException

append

public SegmentedWriter append(char c)
                       throws ClosedChannelException

Specified by:

append in interface Appendable

Overrides:

append in class Writer

Throws:

ClosedChannelException

flush

public void flush()

Specified by:

flush in interface Flushable

Specified by:

flush in class Writer

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class Writer

getLength

public long getLength()

Description copied from class: BufferWriter

Gets the number of characters in this buffer. Once closed, this length will not be modified.

Specified by:

getLength in class BufferWriter

toString

public String toString()

Description copied from class: BufferWriter

Gets a short message (like type and length).

Specified by:

toString in class BufferWriter

See Also:

• To get access to the buffered content.

getResult

public BufferResult getResult()
                       throws IllegalStateException

Description copied from class: BufferWriter

Gets the result from this buffer. The buffer must be closed.

Note: Although the BufferWriter are generally not thread-safe, the BufferResult is thread-safe. It is expected to commonly create a buffer on one thread, but the be able to safely share the result among many threads.

Specified by:

getResult in class BufferWriter

Throws:

IllegalStateException - if not closed