org.mule.runtime.core.internal.streaming.bytes

Class BufferedCursorStream

java.lang.Object

java.io.InputStream

org.mule.runtime.api.streaming.bytes.CursorStream

org.mule.runtime.core.internal.streaming.bytes.BufferedCursorStream

All Implemented Interfaces:

Closeable, AutoCloseable, org.mule.runtime.api.streaming.Cursor

public final class BufferedCursorStream
extends org.mule.runtime.api.streaming.bytes.CursorStream

A CursorStream which pulls its data from an InputStreamBuffer.

To reduce contention on the InputStreamBuffer, this class also uses a local intermediate memory buffer which size must be configured

Since:

4.0

See Also:

InputStreamBuffer

Field Summary

Fields

Modifier and Type	Field and Description
protected long	position

Constructor Summary

Constructors

Constructor and Description
BufferedCursorStream(InputStreamBuffer streamBuffer, org.mule.runtime.api.streaming.bytes.CursorStreamProvider provider) Creates a new instance

Method Summary

Modifier and Type	Method and Description
protected void	assertNotDisposed()
void	close() Closes this stream and invokes the closing callback received in the constructor.
protected int	doRead() Template method to support the read() method.
protected int	doRead(byte[] b, int off, int len) Template method to support the read(byte[], int, int) method
long	getPosition()
org.mule.runtime.api.streaming.bytes.CursorStreamProvider	getProvider()
boolean	isReleased()
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b, int off, int len)
void	release()
void	reset()
void	seek(long position)
long	skip(long n) Equivalent to this.seek(this.getPosition() + n)
protected int	unsigned(int value)

Methods inherited from class java.io.InputStream

available, read

Methods inherited from class java.lang.Object

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

Field Detail

position

protected long position

Constructor Detail

BufferedCursorStream

public BufferedCursorStream(InputStreamBuffer streamBuffer,
                            org.mule.runtime.api.streaming.bytes.CursorStreamProvider provider)

Creates a new instance

Parameters:

streamBuffer - the buffer which provides data

provider - the CursorStreamProvider for the cursors that will consume this buffer

Method Detail

seek

public void seek(long position)
          throws IOException

Specified by:

seek in interface org.mule.runtime.api.streaming.Cursor

Throws:

IOException

doRead

protected int doRead()
              throws IOException

Template method to support the read() method.

Returns:

the read byte or -1 if no more elements are present in the stream

Throws:

IOException

doRead

protected int doRead(byte[] b,
                     int off,
                     int len)
              throws IOException

Template method to support the read(byte[], int, int) method

Parameters:

b - the buffer into which the data is read.

off - the start offset in array b at which the data is written.

len - the maximum number of bytes to read.

Returns:

the total number of bytes read into the buffer, or -1 if there is no more data because the end of the stream has been reached.

Throws:

IOException

getPosition

public long getPosition()

isReleased

public boolean isReleased()

release

public final void release()

getProvider

public org.mule.runtime.api.streaming.bytes.CursorStreamProvider getProvider()

assertNotDisposed

protected void assertNotDisposed()
                          throws IOException

Throws:

IOException

close

public final void close()
                 throws IOException

Closes this stream and invokes the closing callback received in the constructor.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface org.mule.runtime.api.streaming.Cursor

Overrides:

close in class InputStream

Throws:

IOException

read

public final int read()
               throws IOException

Specified by:

read in class InputStream

Throws:

IllegalStateException - if this instance has been disposed

IOException

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

skip

public final long skip(long n)
                throws IOException

Equivalent to this.seek(this.getPosition() + n)

Overrides:

skip in class InputStream

Throws:

IOException

mark

public void mark(int readlimit)

Overrides:

mark in class InputStream

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

Returns:

true

unsigned

protected int unsigned(int value)