ByteArrayHandle (Bio-Formats API)

java.lang.Object
- loci.common.AbstractNIOHandle
- - loci.common.ByteArrayHandle

All Implemented Interfaces:

DataInput, DataOutput, IRandomAccess
```
public class ByteArrayHandle
extends AbstractNIOHandle
```
A wrapper for a byte array that implements the IRandomAccess interface.
Source code:

Trac, Gitweb

See Also:
IRandomAccess

Field Summary

Fields
Modifier and Type Field and Description

protected ByteBuffer buffer
Backing ByteBuffer.

protected static int INITIAL_LENGTH
Initial length of a new file.
- Fields inherited from class loci.common.AbstractNIOHandle
  EOF_ERROR_MSG

Fields
Modifier and Type	Field and Description
`protected ByteBuffer`	`buffer` Backing ByteBuffer.
`protected static int`	`INITIAL_LENGTH` Initial length of a new file.

Constructor Summary

Constructors
Constructor and Description
`ByteArrayHandle()` Creates a random access byte stream to write to a byte array.
`ByteArrayHandle(byte[] bytes)` Creates a random access byte stream to read from, and write to, the bytes specified by the byte[] argument.
`ByteArrayHandle(ByteBuffer bytes)`
`ByteArrayHandle(int capacity)` Creates a random access byte stream to read from, and write to.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()` Closes this random access stream and releases any system resources associated with the stream.
`ByteBuffer`	`getByteBuffer()` Gets the byte buffer backing this handle.
`byte[]`	`getBytes()` Gets the byte array backing this FileHandle.
`long`	`getFilePointer()` Returns the current offset in this stream.
`ByteOrder`	`getOrder()` Returns the current order of the stream.
`long`	`length()` Returns the length of this stream.
`int`	`read(byte[] b)` Reads up to b.length bytes of data from this stream into an array of bytes.
`int`	`read(byte[] b, int off, int len)` Reads up to len bytes of data from this stream into an array of bytes.
`int`	`read(ByteBuffer buf)` Reads up to buffer.capacity() bytes of data from this stream into a ByteBuffer.
`int`	`read(ByteBuffer buf, int off, int len)` Reads up to len bytes of data from this stream into a ByteBuffer.
`boolean`	`readBoolean()`
`byte`	`readByte()`
`char`	`readChar()`
`double`	`readDouble()`
`float`	`readFloat()`
`void`	`readFully(byte[] b)`
`void`	`readFully(byte[] b, int off, int len)`
`int`	`readInt()`
`String`	`readLine()`
`long`	`readLong()`
`short`	`readShort()`
`int`	`readUnsignedByte()`
`int`	`readUnsignedShort()`
`String`	`readUTF()`
`void`	`seek(long pos)` Sets the stream pointer offset, measured from the beginning of this stream, at which the next read or write occurs.
`void`	`setLength(long length)` Sets the new length of the handle.
`void`	`setOrder(ByteOrder order)` Sets the byte order of the stream.
`int`	`skipBytes(int n)`
`void`	`write(byte[] b)`
`void`	`write(byte[] b, int off, int len)`
`void`	`write(ByteBuffer buf)` Writes up to buffer.capacity() bytes of data from the given ByteBuffer to this stream.
`void`	`write(ByteBuffer buf, int off, int len)` Writes up to len bytes of data from the given ByteBuffer to this stream.
`void`	`write(int b)`
`void`	`writeBoolean(boolean v)`
`void`	`writeByte(int v)`
`void`	`writeBytes(String s)`
`void`	`writeChar(int v)`
`void`	`writeChars(String s)`
`void`	`writeDouble(double v)`
`void`	`writeFloat(float v)`
`void`	`writeInt(int v)`
`void`	`writeLong(long v)`
`void`	`writeShort(int v)`
`void`	`writeUTF(String str)`

Methods inherited from class loci.common.AbstractNIOHandle
validateLength, validateMode

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

- Field Detail
  - INITIAL_LENGTH
```
protected static final int INITIAL_LENGTH
```
    Initial length of a new file.
    
    See Also:
    Constant Field Values
  - buffer
```
protected ByteBuffer buffer
```
    Backing ByteBuffer.
- Constructor Detail
  - ByteArrayHandle
```
public ByteArrayHandle(byte[] bytes)
```
    Creates a random access byte stream to read from, and write to, the bytes specified by the byte[] argument.
  - ByteArrayHandle
```
public ByteArrayHandle(ByteBuffer bytes)
```
  - ByteArrayHandle
```
public ByteArrayHandle(int capacity)
```
    Creates a random access byte stream to read from, and write to.
    
    Parameters:
    capacity - Number of bytes to initially allocate.
  - ByteArrayHandle
```
public ByteArrayHandle()
```
    Creates a random access byte stream to write to a byte array.
- Method Detail
  - getBytes
```
public byte[] getBytes()
```
    Gets the byte array backing this FileHandle.
  - getByteBuffer
```
public ByteBuffer getByteBuffer()
```
    Gets the byte buffer backing this handle. NOTE: This is the backing buffer. Any modifications to this buffer including position, length and capacity will affect subsequent calls upon its source handle.
    
    Returns:
    Backing buffer of this handle.
  - setLength
```
public void setLength(long length)
               throws IOException
```
    Description copied from class: AbstractNIOHandle
    
    Sets the new length of the handle.
    
    Specified by:
    
    setLength in class AbstractNIOHandle
    
    Parameters:
    length - New length.
    
    Throws:
    
    IOException - If there is an error changing the handle's length.
  - close
```
public void close()
```
    Description copied from interface: IRandomAccess
    
    Closes this random access stream and releases any system resources associated with the stream.
  - getFilePointer
```
public long getFilePointer()
```
    Description copied from interface: IRandomAccess
    
    Returns the current offset in this stream.
  - length
```
public long length()
```
    Description copied from interface: IRandomAccess
    
    Returns the length of this stream.
  - read
```
public int read(byte[] b)
         throws IOException
```
    Description copied from interface: IRandomAccess
    
    Reads up to b.length bytes of data from this stream into an array of bytes.
    
    Returns:
    the total number of bytes read into the buffer.
    
    Throws:
    
    IOException
  - read
```
public int read(byte[] b,
       int off,
       int len)
         throws IOException
```
    Description copied from interface: IRandomAccess
    
    Reads up to len bytes of data from this stream into an array of bytes.
    
    Returns:
    the total number of bytes read into the buffer.
    
    Throws:
    
    IOException
  - read
```
public int read(ByteBuffer buf)
         throws IOException
```
    Description copied from interface: IRandomAccess
    
    Reads up to buffer.capacity() bytes of data from this stream into a ByteBuffer.
    
    Throws:
    
    IOException
  - read
```
public int read(ByteBuffer buf,
       int off,
       int len)
         throws IOException
```
    Description copied from interface: IRandomAccess
    
    Reads up to len bytes of data from this stream into a ByteBuffer.
    
    Returns:
    the total number of bytes read into the buffer.
    
    Throws:
    
    IOException
  - seek
```
public void seek(long pos)
          throws IOException
```
    Description copied from interface: IRandomAccess
    
    Sets the stream pointer offset, measured from the beginning of this stream, at which the next read or write occurs.
    
    Throws:
    
    IOException
  - getOrder
```
public ByteOrder getOrder()
```
    Description copied from interface: IRandomAccess
    
    Returns the current order of the stream.
    
    Returns:
    See above.
  - setOrder
```
public void setOrder(ByteOrder order)
```
    Description copied from interface: IRandomAccess
    
    Sets the byte order of the stream.
    
    Parameters:
    order - Order to set.
  - readBoolean
```
public boolean readBoolean()
                    throws IOException
```
    Throws:
    
    IOException
  - readByte
```
public byte readByte()
              throws IOException
```
    Throws:
    
    IOException
  - readChar
```
public char readChar()
              throws IOException
```
    Throws:
    
    IOException
  - readDouble
```
public double readDouble()
                  throws IOException
```
    Throws:
    
    IOException
  - readFloat
```
public float readFloat()
                throws IOException
```
    Throws:
    
    IOException
  - readFully
```
public void readFully(byte[] b)
               throws IOException
```
    Throws:
    
    IOException
  - readFully
```
public void readFully(byte[] b,
             int off,
             int len)
               throws IOException
```
    Throws:
    
    IOException
  - readInt
```
public int readInt()
            throws IOException
```
    Throws:
    
    IOException
  - readLine
```
public String readLine()
                throws IOException
```
    Throws:
    
    IOException
  - readLong
```
public long readLong()
              throws IOException
```
    Throws:
    
    IOException
  - readShort
```
public short readShort()
                throws IOException
```
    Throws:
    
    IOException
  - readUnsignedByte
```
public int readUnsignedByte()
                     throws IOException
```
    Throws:
    
    IOException
  - readUnsignedShort
```
public int readUnsignedShort()
                      throws IOException
```
    Throws:
    
    IOException
  - readUTF
```
public String readUTF()
               throws IOException
```
    Throws:
    
    IOException
  - skipBytes
```
public int skipBytes(int n)
              throws IOException
```
    Throws:
    
    IOException
  - write
```
public void write(byte[] b)
           throws IOException
```
    Throws:
    
    IOException
  - write
```
public void write(byte[] b,
         int off,
         int len)
           throws IOException
```
    Throws:
    
    IOException
  - write
```
public void write(ByteBuffer buf)
           throws IOException
```
    Description copied from interface: IRandomAccess
    
    Writes up to buffer.capacity() bytes of data from the given ByteBuffer to this stream.
    
    Throws:
    
    IOException
  - write
```
public void write(ByteBuffer buf,
         int off,
         int len)
           throws IOException
```
    Description copied from interface: IRandomAccess
    
    Writes up to len bytes of data from the given ByteBuffer to this stream.
    
    Throws:
    
    IOException
  - write
```
public void write(int b)
           throws IOException
```
    Throws:
    
    IOException
  - writeBoolean
```
public void writeBoolean(boolean v)
                  throws IOException
```
    Throws:
    
    IOException
  - writeByte
```
public void writeByte(int v)
               throws IOException
```
    Throws:
    
    IOException
  - writeBytes
```
public void writeBytes(String s)
                throws IOException
```
    Throws:
    
    IOException
  - writeChar
```
public void writeChar(int v)
               throws IOException
```
    Throws:
    
    IOException
  - writeChars
```
public void writeChars(String s)
                throws IOException
```
    Throws:
    
    IOException
  - writeDouble
```
public void writeDouble(double v)
                 throws IOException
```
    Throws:
    
    IOException
  - writeFloat
```
public void writeFloat(float v)
                throws IOException
```
    Throws:
    
    IOException
  - writeInt
```
public void writeInt(int v)
              throws IOException
```
    Throws:
    
    IOException
  - writeLong
```
public void writeLong(long v)
               throws IOException
```
    Throws:
    
    IOException
  - writeShort
```
public void writeShort(int v)
                throws IOException
```
    Throws:
    
    IOException
  - writeUTF
```
public void writeUTF(String str)
              throws IOException
```
    Throws:
    
    IOException

Class ByteArrayHandle

Field Summary

Fields inherited from class loci.common.AbstractNIOHandle

Constructor Summary

Method Summary

Methods inherited from class loci.common.AbstractNIOHandle

Methods inherited from class java.lang.Object

Field Detail

INITIAL_LENGTH

buffer

Constructor Detail

ByteArrayHandle

ByteArrayHandle

ByteArrayHandle

ByteArrayHandle

Method Detail

getBytes

getByteBuffer

setLength

close

getFilePointer

length

read

read

read

read

seek

getOrder

setOrder

readBoolean

readByte

readChar

readDouble

readFloat

readFully

readFully

readInt

readLine

readLong

readShort

readUnsignedByte

readUnsignedShort

readUTF

skipBytes

write

write

write

write

write

writeBoolean

writeByte

writeBytes

writeChar

writeChars

writeDouble

writeFloat

writeInt

writeLong

writeShort

writeUTF