com.jogamp.common.nio.ByteBufferInputStream

All Implemented Interfaces:: Closeable, AutoCloseable

public class ByteBufferInputStream extends InputStream

An InputStream implementation based on an underlying ByteBuffer supporting mark.

May be utilized as well with a memory-mapped FileChannel using a size ≤ Integer.MAX_VALUE.
This becomes efficient with files ≥ 10 MiB, depending on the platform and whether the traditional method uses a BufferedInputStream supporting mark incl. it's buffer size.
See test case com.jogamp.common.nio.TestByteBufferInputStream.

Since:: 2.3.0

Constructor Summary

Constructors

Constructor

Description

ByteBufferInputStream(ByteBuffer buf)

Creates a new byte-buffer input stream.
Method Summary

Modifier and Type

Method

Description

final int

available()

final ByteBuffer

getBuffer()

final void

mark(int unused)

This implementation supports mark.

final boolean

markSupported()

This implementation supports mark.

final int

read()

final int

read(byte[] b, int off, int len)

final int

read(ByteBuffer b, int len)

final void

reset()

This implementation supports mark.

final long

skip(long n)

Methods inherited from class java.io.InputStream
close, nullInputStream, read, 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
- ByteBufferInputStream
  
  public ByteBufferInputStream(ByteBuffer buf)
  
  Creates a new byte-buffer input stream.
  
  Parameters:
  
  buf - the underlying byte buffer.
Method Details
- available
  
  public final int available()
  
  Overrides:
  
  available in class InputStream
- markSupported
  
  public final boolean markSupported()
  
  This implementation supports mark.
  
  Overrides:
  
  markSupported in class InputStream
- mark
  
  public final void mark(int unused)
  
  This implementation supports mark.
  Overrides:
  
  mark in class InputStream
  
  See Also:
  
  markSupported()
- reset
  
  public final void reset() throws IOException
  
  This implementation supports mark.
  Overrides:
  
  reset in class InputStream
  
  Throws:
  
  IOException
  
  See Also:
  
  markSupported()
- skip
  
  public final long skip(long n) throws IOException
  
  Overrides:
  
  skip in class InputStream
  
  Throws:
  
  IOException
- read
  
  public final int read()
  
  Specified by:
  
  read in class InputStream
- read
  
  public final int read(byte[] b, int off, int len)
  
  Overrides:
  
  read in class InputStream
- read
  
  public final int read(ByteBuffer b, int len)
- getBuffer
  
  public final ByteBuffer getBuffer()

Class ByteBufferInputStream

Constructor Summary

Method Summary

Methods inherited from class java.io.InputStream

Methods inherited from class java.lang.Object

Constructor Details

ByteBufferInputStream

Method Details

available

markSupported

mark

reset

skip

read

read

read

getBuffer