Package com.helger.commons.io.stream

Class ByteBuffersInputStream

java.lang.Object

java.io.InputStream

com.helger.commons.io.stream.ByteBuffersInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

@NotThreadSafe
public final class ByteBuffersInputStream
extends InputStream

InputStream wrapped around one or more ByteBuffer objects.

Author:

Philip Helger

Constructor Summary

Constructors

Constructor	Description
ByteBuffersInputStream(ByteBuffer... aBuffers)	Constructor

Method Summary

Modifier and Type	Method	Description
int	available()
void	close()
ByteBuffer[]	getAllBuffers()
long	getAvailable()
boolean	isAnythingAvailable()
boolean	isClosed()
void	mark(int nReadlimit)
boolean	markSupported()
int	read()
int	read(byte[] aBuf)
int	read(byte[] aBuf, int nOfs, int nLen)
long	read(ByteBuffer aDestByteBuffer)	Reads as much as possible into the destination buffer.
void	reset()
long	skip(long nBytesToSkip)

Methods inherited from class java.io.InputStream

nullInputStream, readAllBytes, readNBytes, readNBytes, skipNBytes, transferTo

Methods inherited from class java.lang.Object

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

Constructor Details

ByteBuffersInputStream

public ByteBuffersInputStream(@Nonnull @Nonempty
 ByteBuffer... aBuffers)

Constructor

Parameters:

aBuffers - Array of ByteBuffer. May neither be null nor empty and may not contain null elements.

Method Details

isClosed

public boolean isClosed()

getAllBuffers

@Nonnull
@ReturnsMutableCopy
public ByteBuffer[] getAllBuffers()

Returns:

A copy of the array with the byte buffers. Never null.

isAnythingAvailable

public boolean isAnythingAvailable()

Returns:

true if any byte buffer has at least one byte left.

getAvailable

@Nonnegative
public long getAvailable()

Returns:

The number of available bytes as a long. Always ≥ 0.

available

@Nonnegative
public int available()

Overrides:

available in class InputStream

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class InputStream

mark

public void mark(int nReadlimit)

Overrides:

mark in class InputStream

reset

public void reset()

Overrides:

reset in class InputStream

markSupported

public boolean markSupported()

Overrides:

markSupported in class InputStream

read

public int read()

Specified by:

read in class InputStream

read

public int read(@Nonnull
 byte[] aBuf)

Overrides:

read in class InputStream

read

public int read(@Nonnull
 byte[] aBuf,
 @Nonnegative
 int nOfs,
 @Nonnegative
 int nLen)

Overrides:

read in class InputStream

skip

@Nonnegative
public long skip(long nBytesToSkip)

Overrides:

skip in class InputStream

read

@Nonnegative
public long read(@Nonnull
 ByteBuffer aDestByteBuffer)

Reads as much as possible into the destination buffer.

Parameters:

aDestByteBuffer - The destination byte buffer to use. May not be null.

Returns:

The number of bytes read. Always ≥ 0.