net.sf.kdgcommons.buffer

Class ByteBufferInputStream

java.lang.Object

java.io.InputStream

net.sf.kdgcommons.buffer.ByteBufferInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class ByteBufferInputStream
extends InputStream

An InputStream that reads from an existing ByteBuffer. Will reposition the buffer at construction, and read sequentially from that point. Attempting to read past the buffer's limit will return end-of-file.

Warnings: Because this class explicitly repositions the buffer, you should not create two instances around the same buffer; slice() the buffer instead. Instances of this class are only as thread-safe as the underlying buffer (and the JavaDocs don't have much to say about that).

Constructor Summary

Constructors

Constructor and Description
ByteBufferInputStream(ByteBuffer buf) Creates an instance that positions the stream at the start of the buffer.
ByteBufferInputStream(ByteBuffer buf, int off) Creates an instance that positions the stream at the specified offset.

Method Summary

Modifier and Type	Method and Description
int	available()
void	close()
void	mark(int readlimit)
boolean	markSupported()
int	read()
int	read(byte[] b)
int	read(byte[] b, int off, int len)
void	reset()
long	skip(long n)

Methods inherited from class java.lang.Object

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

Constructor Detail

ByteBufferInputStream

public ByteBufferInputStream(ByteBuffer buf)

Creates an instance that positions the stream at the start of the buffer.

ByteBufferInputStream

public ByteBufferInputStream(ByteBuffer buf,
                             int off)

Creates an instance that positions the stream at the specified offset.

Method Detail

available

public int available()
              throws IOException

Overrides:

available in class InputStream

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class InputStream

Throws:

IOException

mark

public void mark(int readlimit)

Overrides:

mark in class InputStream

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

read

public int read()
         throws IOException

Specified by:

read in class InputStream

Throws:

IOException

read

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

Overrides:

read in class InputStream

Throws:

IOException

read

public int read(byte[] b)
         throws IOException

Overrides:

read in class InputStream

Throws:

IOException

reset

public void reset()
           throws IOException

Overrides:

reset in class InputStream

Throws:

IOException

skip

public long skip(long n)
          throws IOException

Overrides:

skip in class InputStream

Throws:

IOException