Package org.jgrapes.io.util

Class ManagedBufferReader

java.lang.Object

java.io.Reader

org.jgrapes.io.util.ManagedBufferReader

All Implemented Interfaces:

Closeable, AutoCloseable, Readable

public class ManagedBufferReader
extends Reader

A Reader that provides the data from the ManagedBuffers fed to it to a consumer.

This class is intended to be used as a pipe between two threads.

Field Summary

Fields inherited from class java.io.Reader

lock

Constructor Summary

Constructors

Constructor	Description
ManagedBufferReader()

Method Summary

Modifier and Type	Method	Description
ManagedBufferReader	charset(Charset charset)	Sets the charset to be used if feed(ManagedBuffer) is invoked with ManagedBuffer<ByteBuffer>.
void	close()	Note that this is the Reader’s close method.
<W extends Buffer> void	feed(ManagedBuffer<W> buffer)	Feed data to the reader.
ManagedBufferReader	nativeCharset()	Sets the charset to be used if feed(ManagedBuffer) is invoked with ManagedBuffer<ByteBuffer> to the charset specified as system property native.encoding.
int	read(char[] cbuf, int off, int len)
ManagedBufferReader	setCharset(Charset charset)	Deprecated. Use charset(Charset) instead

Methods inherited from class java.io.Reader

mark, markSupported, nullReader, read, read, read, ready, reset, skip, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

ManagedBufferReader

public ManagedBufferReader()

Method Details

charset

public ManagedBufferReader charset(Charset charset)

Sets the charset to be used if feed(ManagedBuffer) is invoked with ManagedBuffer<ByteBuffer>.

Defaults to UTF-8. Must be set before the first invocation of feed(ManagedBuffer).

Parameters:

charset - the charset

Returns:

the managed buffer reader

setCharset

@Deprecated
public ManagedBufferReader setCharset(Charset charset)

Deprecated.

Use charset(Charset) instead

Sets the charset to be used if feed(ManagedBuffer) is invoked with ManagedBuffer<ByteBuffer>.

Defaults to UTF-8. Must be set before the first invocation of feed(ManagedBuffer).

Parameters:

charset - the charset

Returns:

the managed buffer reader

nativeCharset

public ManagedBufferReader nativeCharset()

Sets the charset to be used if feed(ManagedBuffer) is invoked with ManagedBuffer<ByteBuffer> to the charset specified as system property native.encoding.

If this property does not specify a valid charset, Charset.defaultCharset() is used.

Must be invoked before the first invocation of feed(ManagedBuffer).

Returns:

the managed buffer reader

feed

public <W extends Buffer> void feed(ManagedBuffer<W> buffer)
                             throws IOException

Feed data to the reader.

The call blocks while data from a previous invocation has not been fully read. The buffer passed as argument is locked (see ManagedBuffer.lockBuffer()) until all data has been read.

Calling this method with null as argument closes the feed. After consuming any data still available from a previous invocation, further calls to read(char[], int, int) therefore return -1.

Parameters:

buffer - the buffer

Throws:

IOException - Signals that an I/O exception has occurred.

close

public void close()
           throws IOException

Note that this is the Reader’s close method.

In order to close the feed, call feed(ManagedBuffer) with null as argument.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in class Reader

Throws:

IOException

read

public int read(char[] cbuf,
 int off,
 int len)
         throws IOException

Specified by:

read in class Reader

Throws:

IOException