DataHandleAdapter (SCIFIO Javadocs 0-SNAPSHOT API)

java.lang.Object
- java.io.InputStream
- - loci.common.RandomAccessInputStream
  - - io.scif.bf.wrapper.DataHandleAdapter

All Implemented Interfaces:

com.esotericsoftware.kryo.KryoSerializable, Closeable, DataInput, DataOutput, AutoCloseable, loci.common.IRandomAccess
```
public class DataHandleAdapter
extends loci.common.RandomAccessInputStream
implements loci.common.IRandomAccess
```
Adapter class to convert DataHandle to RandomAccessInputStream.

Field Summary
- Fields inherited from class loci.common.RandomAccessInputStream
  DEFAULT_BLOCK_SIZE, encoding, file, length, markedPos, MAX_OVERHEAD, MAX_SEARCH_SIZE, raf

Constructor Summary

Constructors
Constructor and Description

DataHandleAdapter(DataHandle<Location> handle)

Constructors
Constructor and Description
`DataHandleAdapter(DataHandle<Location> handle)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`available()`
`void`	`close()`
`boolean`	`exists()`
`String`	`findString(boolean saveString, int blockSize, String... terminators)`
`String`	`findString(boolean saveString, String... terminators)`
`String`	`findString(int blockSize, String... terminators)`
`String`	`findString(String... terminators)`
`long`	`getFilePointer()`
`ByteOrder`	`getOrder()`
`boolean`	`isLittleEndian()`
`long`	`length()`
`void`	`mark(int readLimit)`
`boolean`	`markSupported()`
`void`	`order(boolean little)`
`int`	`read()`
`int`	`read(byte[] array)`
`int`	`read(byte[] array, int offset, int n)`
`int`	`read(ByteBuffer buf)`
`int`	`read(ByteBuffer buf, int offset, int n)`
`boolean`	`readBoolean()`
`byte`	`readByte()`
`char`	`readChar()`
`String`	`readCString()`
`double`	`readDouble()`
`float`	`readFloat()`
`void`	`readFully(byte[] array)`
`void`	`readFully(byte[] array, int offset, int n)`
`int`	`readInt()`
`String`	`readLine()`
`long`	`readLong()`
`short`	`readShort()`
`String`	`readString(int n)`
`String`	`readString(String lastChars)`
`int`	`readUnsignedByte()`
`int`	`readUnsignedShort()`
`String`	`readUTF()`
`void`	`reset()`
`void`	`seek(long pos)`
`void`	`setEncoding(String encoding)`
`void`	`setLength(long newLength)`
`void`	`setOrder(ByteOrder order)`
`int`	`skipBytes(int n)`
`DataHandle<Location>`	`unwrap()`
`void`	`write(byte[] b)`
`void`	`write(byte[] b, int off, int len)`
`void`	`write(ByteBuffer buf)`
`void`	`write(ByteBuffer buf, int off, int len)`
`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 s)`

Methods inherited from class loci.common.RandomAccessInputStream
isBitOnByteBoundary, read, readBits, readByteToString, readUnsignedInt, skipBits, skipBytes, write

Methods inherited from class java.io.InputStream
skip

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

Methods inherited from interface loci.common.IRandomAccess
skipBytes

- Constructor Detail
  - DataHandleAdapter
```
public DataHandleAdapter(DataHandle<Location> handle)
                  throws IOException
```
    Throws:
    
    IOException
- Method Detail
  - unwrap
```
public DataHandle<Location> unwrap()
```
  - setEncoding
```
public void setEncoding(String encoding)
```
    Overrides:
    
    setEncoding in class loci.common.RandomAccessInputStream
  - seek
```
public void seek(long pos)
          throws IOException
```
    Specified by:
    
    seek in interface loci.common.IRandomAccess
    
    Overrides:
    
    seek in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - length
```
public long length()
            throws IOException
```
    Specified by:
    
    length in interface loci.common.IRandomAccess
    
    Overrides:
    
    length in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - setLength
```
public void setLength(long newLength)
               throws IOException
```
    Overrides:
    
    setLength in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - getFilePointer
```
public long getFilePointer()
                    throws IOException
```
    Specified by:
    
    getFilePointer in interface loci.common.IRandomAccess
    
    Overrides:
    
    getFilePointer in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - exists
```
public boolean exists()
               throws IOException
```
    Specified by:
    
    exists in interface loci.common.IRandomAccess
    
    Throws:
    
    IOException
  - close
```
public void close()
           throws IOException
```
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface loci.common.IRandomAccess
    
    Overrides:
    
    close in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - order
```
public void order(boolean little)
```
    Overrides:
    
    order in class loci.common.RandomAccessInputStream
  - isLittleEndian
```
public boolean isLittleEndian()
```
    Overrides:
    
    isLittleEndian in class loci.common.RandomAccessInputStream
  - readString
```
public String readString(String lastChars)
                  throws IOException
```
    Overrides:
    
    readString in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - findString
```
public String findString(String... terminators)
                  throws IOException
```
    Overrides:
    
    findString in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - findString
```
public String findString(boolean saveString,
                         String... terminators)
                  throws IOException
```
    Overrides:
    
    findString in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - findString
```
public String findString(int blockSize,
                         String... terminators)
                  throws IOException
```
    Overrides:
    
    findString in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - findString
```
public String findString(boolean saveString,
                         int blockSize,
                         String... terminators)
                  throws IOException
```
    Overrides:
    
    findString in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - readBoolean
```
public boolean readBoolean()
                    throws IOException
```
    Specified by:
    
    readBoolean in interface DataInput
    
    Overrides:
    
    readBoolean in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - readByte
```
public byte readByte()
              throws IOException
```
    Specified by:
    
    readByte in interface DataInput
    
    Overrides:
    
    readByte in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - readChar
```
public char readChar()
              throws IOException
```
    Specified by:
    
    readChar in interface DataInput
    
    Overrides:
    
    readChar in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - readDouble
```
public double readDouble()
                  throws IOException
```
    Specified by:
    
    readDouble in interface DataInput
    
    Overrides:
    
    readDouble in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - readFloat
```
public float readFloat()
                throws IOException
```
    Specified by:
    
    readFloat in interface DataInput
    
    Overrides:
    
    readFloat in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - readInt
```
public int readInt()
            throws IOException
```
    Specified by:
    
    readInt in interface DataInput
    
    Overrides:
    
    readInt in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - readLine
```
public String readLine()
                throws IOException
```
    Specified by:
    
    readLine in interface DataInput
    
    Overrides:
    
    readLine in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - readCString
```
public String readCString()
                   throws IOException
```
    Overrides:
    
    readCString in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - readString
```
public String readString(int n)
                  throws IOException
```
    Overrides:
    
    readString in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - readLong
```
public long readLong()
              throws IOException
```
    Specified by:
    
    readLong in interface DataInput
    
    Overrides:
    
    readLong in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - readShort
```
public short readShort()
                throws IOException
```
    Specified by:
    
    readShort in interface DataInput
    
    Overrides:
    
    readShort in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - readUnsignedByte
```
public int readUnsignedByte()
                     throws IOException
```
    Specified by:
    
    readUnsignedByte in interface DataInput
    
    Overrides:
    
    readUnsignedByte in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - readUnsignedShort
```
public int readUnsignedShort()
                      throws IOException
```
    Specified by:
    
    readUnsignedShort in interface DataInput
    
    Overrides:
    
    readUnsignedShort in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - readUTF
```
public String readUTF()
               throws IOException
```
    Specified by:
    
    readUTF in interface DataInput
    
    Overrides:
    
    readUTF in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - skipBytes
```
public int skipBytes(int n)
              throws IOException
```
    Specified by:
    
    skipBytes in interface DataInput
    
    Overrides:
    
    skipBytes in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - read
```
public int read(byte[] array)
         throws IOException
```
    Specified by:
    
    read in interface loci.common.IRandomAccess
    
    Overrides:
    
    read in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - read
```
public int read(byte[] array,
                int offset,
                int n)
         throws IOException
```
    Specified by:
    
    read in interface loci.common.IRandomAccess
    
    Overrides:
    
    read in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - read
```
public int read(ByteBuffer buf)
         throws IOException
```
    Specified by:
    
    read in interface loci.common.IRandomAccess
    
    Overrides:
    
    read in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - read
```
public int read(ByteBuffer buf,
                int offset,
                int n)
         throws IOException
```
    Specified by:
    
    read in interface loci.common.IRandomAccess
    
    Overrides:
    
    read in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - readFully
```
public void readFully(byte[] array)
               throws IOException
```
    Specified by:
    
    readFully in interface DataInput
    
    Overrides:
    
    readFully in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - readFully
```
public void readFully(byte[] array,
                      int offset,
                      int n)
               throws IOException
```
    Specified by:
    
    readFully in interface DataInput
    
    Overrides:
    
    readFully in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - read
```
public int read()
         throws IOException
```
    Overrides:
    
    read in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - available
```
public int available()
              throws IOException
```
    Overrides:
    
    available in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - mark
```
public void mark(int readLimit)
```
    Overrides:
    
    mark in class loci.common.RandomAccessInputStream
  - markSupported
```
public boolean markSupported()
```
    Overrides:
    
    markSupported in class loci.common.RandomAccessInputStream
  - reset
```
public void reset()
           throws IOException
```
    Overrides:
    
    reset in class loci.common.RandomAccessInputStream
    
    Throws:
    
    IOException
  - write
```
public void write(int b)
           throws IOException
```
    Specified by:
    
    write in interface DataOutput
    
    Throws:
    
    IOException
  - write
```
public void write(byte[] b)
           throws IOException
```
    Specified by:
    
    write in interface DataOutput
    
    Throws:
    
    IOException
  - write
```
public void write(byte[] b,
                  int off,
                  int len)
           throws IOException
```
    Specified by:
    
    write in interface DataOutput
    
    Throws:
    
    IOException
  - writeBoolean
```
public void writeBoolean(boolean v)
                  throws IOException
```
    Specified by:
    
    writeBoolean in interface DataOutput
    
    Throws:
    
    IOException
  - writeByte
```
public void writeByte(int v)
               throws IOException
```
    Specified by:
    
    writeByte in interface DataOutput
    
    Throws:
    
    IOException
  - writeShort
```
public void writeShort(int v)
                throws IOException
```
    Specified by:
    
    writeShort in interface DataOutput
    
    Throws:
    
    IOException
  - writeChar
```
public void writeChar(int v)
               throws IOException
```
    Specified by:
    
    writeChar in interface DataOutput
    
    Throws:
    
    IOException
  - writeInt
```
public void writeInt(int v)
              throws IOException
```
    Specified by:
    
    writeInt in interface DataOutput
    
    Throws:
    
    IOException
  - writeLong
```
public void writeLong(long v)
               throws IOException
```
    Specified by:
    
    writeLong in interface DataOutput
    
    Throws:
    
    IOException
  - writeFloat
```
public void writeFloat(float v)
                throws IOException
```
    Specified by:
    
    writeFloat in interface DataOutput
    
    Throws:
    
    IOException
  - writeDouble
```
public void writeDouble(double v)
                 throws IOException
```
    Specified by:
    
    writeDouble in interface DataOutput
    
    Throws:
    
    IOException
  - writeBytes
```
public void writeBytes(String s)
                throws IOException
```
    Specified by:
    
    writeBytes in interface DataOutput
    
    Throws:
    
    IOException
  - writeChars
```
public void writeChars(String s)
                throws IOException
```
    Specified by:
    
    writeChars in interface DataOutput
    
    Throws:
    
    IOException
  - writeUTF
```
public void writeUTF(String s)
              throws IOException
```
    Specified by:
    
    writeUTF in interface DataOutput
    
    Throws:
    
    IOException
  - getOrder
```
public ByteOrder getOrder()
```
    Specified by:
    
    getOrder in interface loci.common.IRandomAccess
  - setOrder
```
public void setOrder(ByteOrder order)
```
    Specified by:
    
    setOrder in interface loci.common.IRandomAccess
  - write
```
public void write(ByteBuffer buf)
           throws IOException
```
    Specified by:
    
    write in interface loci.common.IRandomAccess
    
    Throws:
    
    IOException
  - write
```
public void write(ByteBuffer buf,
                  int off,
                  int len)
           throws IOException
```
    Specified by:
    
    write in interface loci.common.IRandomAccess
    
    Throws:
    
    IOException

Class DataHandleAdapter

Field Summary

Fields inherited from class loci.common.RandomAccessInputStream

Constructor Summary

Method Summary

Methods inherited from class loci.common.RandomAccessInputStream

Methods inherited from class java.io.InputStream

Methods inherited from class java.lang.Object

Methods inherited from interface loci.common.IRandomAccess

Constructor Detail

DataHandleAdapter

Method Detail

unwrap

setEncoding

seek

length

setLength

getFilePointer

exists

close

order

isLittleEndian

readString

findString

findString

findString

findString

readBoolean

readByte

readChar

readDouble

readFloat

readInt

readLine

readCString

readString

readLong

readShort

readUnsignedByte

readUnsignedShort

readUTF

skipBytes

read

read

read

read

readFully

readFully

read

available

mark

markSupported

reset

write

write

write

writeBoolean

writeByte

writeShort

writeChar

writeInt

writeLong

writeFloat

writeDouble

writeBytes

writeChars

writeUTF

getOrder

setOrder

write

write