org.jaffre.io

Class AbstractByteBufferInputStream

java.lang.Object

java.io.InputStream

org.jaffre.io.AbstractByteBufferInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public abstract class AbstractByteBufferInputStream
extends InputStream

This class is not synchronized.

Author:

Alexander Veit

Field Summary

Fields

Modifier and Type	Field and Description
protected ByteBuffer	m_buffer

Constructor Summary

Constructors

Constructor and Description
AbstractByteBufferInputStream(ByteBuffer p_buffer, boolean p_bContainsData) Create an input stream that reads a java.nio.ByteBuffer.
AbstractByteBufferInputStream(int p_iCapacity)

Method Summary

Methods

Modifier and Type	Method and Description
int	available() Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream.
void	close() This method does nothing.
void	mark(int p_iReadlimit)
boolean	markSupported() Marks are not supported by this stream.
int	read()
int	read(byte[] p_buf)
int	read(byte[] p_buf, int p_iOffs, int p_iLen)
abstract int	read(ByteBuffer p_buffer) Read bytes into the given input buffer.
void	reset()
long	skip(long p_lSkip)

Methods inherited from class java.lang.Object

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

Field Detail

m_buffer

protected ByteBuffer m_buffer

Constructor Detail

AbstractByteBufferInputStream

public AbstractByteBufferInputStream(ByteBuffer p_buffer,
                             boolean p_bContainsData)

Create an input stream that reads a java.nio.ByteBuffer.

The given buffer will be read and will be passed in calls to the read(ByteBuffer) in order to be refilled.

Parameters:

p_buffer - The buffer to be read.

p_bContainsData - true if the buffer already contains data and is prepared for subsequent relative get operations, or false if the buffer does not contain any data that should be read by this input stream.

AbstractByteBufferInputStream

public AbstractByteBufferInputStream(int p_iCapacity)

Method Detail

available

public int available()
              throws IOException

Returns an estimate of the number of bytes that can be read (or skipped over) from this input stream without blocking by the next invocation of a method for this input stream.

The value is equal to the number of bytes remaining in the underlying buffer, or 1 if the underlying buffer contains no data when this method is called.

Overrides:

available in class InputStream

Returns:

The estimate number of bytes that can be read (or skipped over) from this input stream

Throws:

IOException

See Also:

Buffer.remaining()

markSupported

public boolean markSupported()

Marks are not supported by this stream.

Overrides:

markSupported in class InputStream

Returns:

Always false;

mark

public void mark(int p_iReadlimit)

Overrides:

mark in class InputStream

Throws:

UnsupportedOperationException - Marks are not supported by this stream.

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

UnsupportedOperationException - Marks are not supported by this stream.

IOException

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

public int read(byte[] p_buf,
       int p_iOffs,
       int p_iLen)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

read

public int read(byte[] p_buf)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

skip

public long skip(long p_lSkip)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException

read

public abstract int read(ByteBuffer p_buffer)
                  throws IOException

Read bytes into the given input buffer.

Note:

• The input buffer passed is compacted.
• Implementors must ensure that this method will never return 0.
• Also, this method must prepare the input buffer for subsequent relative get operations.

Parameters:

p_buffer - The buffer.

Returns:

The number of bytes read, or -1 if no more input is available.

Throws:

IOException - If an I/O error occurred.

close

public void close()
           throws IOException

This method does nothing.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

Throws:

IOException