ByteBufferByteBank (SciJava Javadocs 0-SNAPSHOT API)

java.lang.Object
- org.scijava.io.nio.ByteBufferByteBank

All Implemented Interfaces:

ByteBank
```
public class ByteBufferByteBank
extends Object
implements ByteBank
```
A ByteBank backed by a ByteBuffer. Self-growing up to a maximal capacity of Integer.MAX_VALUE

Author:

Gabriel Einsdorf

Constructor Summary

Constructors
Constructor and Description
`ByteBufferByteBank()`
`ByteBufferByteBank(Function<Integer,ByteBuffer> provider)`
`ByteBufferByteBank(Function<Integer,ByteBuffer> provider, int initialCapacity)`
`ByteBufferByteBank(int initialCapacity)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Clears the buffer
`byte`	`getByte(long pos)`
`int`	`getBytes(long startPos, byte[] b, int offset, int length)`
`long`	`getMaxBufferSize()`
`boolean`	`isReadOnly()`
`void`	`setByte(long pos, byte b)` Sets the byte at the given position
`void`	`setBytes(long startpos, byte[] bytes, int offset, int length)` Sets the bytes starting form the given position to the values form the provided array.
`long`	`size()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.scijava.io.ByteBank
appendBytes, appendBytes, basicRangeCheck, checkReadPos, checkWritePos, getBytes, toByteArray, toByteArray

- Constructor Detail
  - ByteBufferByteBank
```
public ByteBufferByteBank()
```
  - ByteBufferByteBank
```
public ByteBufferByteBank(Function<Integer,ByteBuffer> provider)
```
  - ByteBufferByteBank
```
public ByteBufferByteBank(Function<Integer,ByteBuffer> provider,
                          int initialCapacity)
```
  - ByteBufferByteBank
```
public ByteBufferByteBank(int initialCapacity)
```
- Method Detail
  - getMaxBufferSize
```
public long getMaxBufferSize()
```
    Specified by:
    
    getMaxBufferSize in interface ByteBank
    
    Returns:
    
    the maximal size of the buffer
  - setBytes
```
public void setBytes(long startpos,
                     byte[] bytes,
                     int offset,
                     int length)
```
    Description copied from interface: ByteBank
    
    Sets the bytes starting form the given position to the values form the provided array.
    
    Specified by:
    
    setBytes in interface ByteBank
    
    Parameters:
    
    startpos - the position in the buffer to start writing from
    
    bytes - the byte array to write
    
    offset - the offset in the bytes array
    
    length - the number of bytes to read
  - setByte
```
public void setByte(long pos,
                    byte b)
```
    Description copied from interface: ByteBank
    
    Sets the byte at the given position
    
    Specified by:
    
    setByte in interface ByteBank
    
    Parameters:
    
    pos - the position
    
    b - the value to set
  - clear
```
public void clear()
```
    Description copied from interface: ByteBank
    
    Clears the buffer
    
    Specified by:
    
    clear in interface ByteBank
  - getByte
```
public byte getByte(long pos)
```
    Specified by:
    
    getByte in interface ByteBank
    
    Parameters:
    
    pos - the position to read from
    
    Returns:
    
    the byte at the given position
  - getBytes
```
public int getBytes(long startPos,
                    byte[] b,
                    int offset,
                    int length)
```
    Specified by:
    
    getBytes in interface ByteBank
    
    Parameters:
    
    startPos - the position in the buffer to start reading from
    
    b - the byte array to read into
    
    offset - the offset in the bytes array
    
    length - the number of elements to read into the bytes array
    
    Returns:
    
    number of bytes read
  - size
```
public long size()
```
    Specified by:
    
    size in interface ByteBank
    
    Returns:
    
    the offset which follows the last byte stored in this ByteBank
  - isReadOnly
```
public boolean isReadOnly()
```
    Specified by:
    
    isReadOnly in interface ByteBank
    
    Returns:
    
    True iff the buffer is read-only.

Class ByteBufferByteBank

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.scijava.io.ByteBank

Constructor Detail

ByteBufferByteBank

ByteBufferByteBank

ByteBufferByteBank

ByteBufferByteBank

Method Detail

getMaxBufferSize

setBytes

setByte

clear

getByte

getBytes

size

isReadOnly