com.imagero.uio
Interface RandomAccessRO

All Superinterfaces:
java.io.DataInput, Input
All Known Subinterfaces:
RandomAccess
All Known Implementing Classes:
AbstractRandomAccess, AbstractRandomAccessRO

public interface RandomAccessRO
extends Input, java.io.DataInput

Interface for read only access to data. Allows unified read access to data - arrays, files, streams and many other.


Field Summary
static int BIG_ENDIAN
           
static int LITTLE_ENDIAN
           
 
Method Summary
 int getByteOrder()
          get byte order
 long getFilePointer()
          Since this is an interface and is not restricted to files, "getFilePointer" is wrong name for this method.
 long length()
          get length of data
 byte[] readByteLine()
          like readLine but returns byte array
 void readFully(char[] dest)
          read data into char array
 void readFully(char[] dest, int byteOrder)
          read data into char array
 void readFully(char[] dest, int destOffset, int len)
          read data into char array
 void readFully(char[] dest, int destOffset, int len, int byteOrder)
          read data into char array
 void readFully(double[] dest)
          read data into double array
 void readFully(double[] dest, int byteOrder)
          read data into double array
 void readFully(double[] dest, int destOffset, int len)
          read data into double array
 void readFully(double[] dest, int destOffset, int len, int byteOrder)
          read data into double array
 void readFully(float[] dest)
          read data into float array
 void readFully(float[] dest, int byteOrder)
          read data into float array
 void readFully(float[] dest, int destOffset, int len)
          read data into float array
 void readFully(float[] dest, int destOffset, int len, int byteOrder)
          read data into float array
 void readFully(int[] dest)
          read data into int array
 void readFully(int[] dest, int byteOrder)
          read data into int array
 void readFully(int[] dest, int destOffset, int len)
          read data into int array
 void readFully(int[] dest, int destOffset, int len, int byteOrder)
          read data into int array
 void readFully(long[] dest)
          read data into long array
 void readFully(long[] dest, int byteOrder)
          read data into long array
 void readFully(long[] dest, int destOffset, int len)
          read data into long array
 void readFully(long[] dest, int destOffset, int len, int byteOrder)
          read data into long array
 void readFully(short[] dest)
          read data into short array
 void readFully(short[] dest, int byteOrder)
          read data into short array
 void readFully(short[] dest, int destOffset, int len)
          read data into short array
 void readFully(short[] dest, int destOffset, int len, int byteOrder)
          read data into short array
 void seek(long offset)
          set current cursor position to specified offset
 void setByteOrder(int byteOrder)
          set byte order
 
Methods inherited from interface com.imagero.uio.Input
close, read, read, read, skip
 
Methods inherited from interface java.io.DataInput
readBoolean, readByte, readChar, readDouble, readFloat, readFully, readFully, readInt, readLine, readLong, readShort, readUnsignedByte, readUnsignedShort, readUTF, skipBytes
 

Field Detail

BIG_ENDIAN

public static final int BIG_ENDIAN
See Also:
Constant Field Values

LITTLE_ENDIAN

public static final int LITTLE_ENDIAN
See Also:
Constant Field Values
Method Detail

getFilePointer

public long getFilePointer()
                    throws java.io.IOException
Since this is an interface and is not restricted to files, "getFilePointer" is wrong name for this method. But I leaved it so for easier porting from RandomAccessFile

Returns:
current cursor position
Throws:
java.io.IOException

length

public long length()
            throws java.io.IOException
get length of data

Returns:
data length (in bytes)
Throws:
java.io.IOException

seek

public void seek(long offset)
          throws java.io.IOException
set current cursor position to specified offset

Parameters:
offset - new cursor position
Throws:
java.io.IOException

getByteOrder

public int getByteOrder()
get byte order

Returns:
RandomAccessFactory.BIG_ENDIAN or RandomAccessFactory.LITTLE_ENDIAN
See Also:
RandomAccessFactory.BIG_ENDIAN, RandomAccessFactory.LITTLE_ENDIAN

setByteOrder

public void setByteOrder(int byteOrder)
                  throws java.io.IOException
set byte order

Parameters:
byteOrder -
Throws:
java.io.IOException
See Also:
RandomAccessFactory.BIG_ENDIAN, RandomAccessFactory.LITTLE_ENDIAN

readFully

public void readFully(short[] dest)
               throws java.io.IOException
read data into short array

Parameters:
dest - buffer to store data
Throws:
java.io.IOException

readFully

public void readFully(short[] dest,
                      int byteOrder)
               throws java.io.IOException
read data into short array

Parameters:
dest - buffer to store data
byteOrder - byte order
Throws:
java.io.IOException

readFully

public void readFully(short[] dest,
                      int destOffset,
                      int len)
               throws java.io.IOException
read data into short array

Parameters:
dest - buffer to store data
destOffset - offset in buffer
len - number of shorts to read
Throws:
java.io.IOException

readFully

public void readFully(short[] dest,
                      int destOffset,
                      int len,
                      int byteOrder)
               throws java.io.IOException
read data into short array

Parameters:
dest - buffer to store data
destOffset - offset in buffer
len - number of shorts to read
byteOrder - byte order
Throws:
java.io.IOException

readFully

public void readFully(char[] dest)
               throws java.io.IOException
read data into char array

Parameters:
dest - buffer to store data
Throws:
java.io.IOException

readFully

public void readFully(char[] dest,
                      int byteOrder)
               throws java.io.IOException
read data into char array

Parameters:
dest - buffer to store data
byteOrder - byte order
Throws:
java.io.IOException

readFully

public void readFully(char[] dest,
                      int destOffset,
                      int len)
               throws java.io.IOException
read data into char array

Parameters:
dest - buffer to store data
destOffset - offset in buffer
len - number of chars to read
Throws:
java.io.IOException

readFully

public void readFully(char[] dest,
                      int destOffset,
                      int len,
                      int byteOrder)
               throws java.io.IOException
read data into char array

Parameters:
dest - buffer to store data
destOffset - offset in buffer
len - number of chars to read
byteOrder - byte order
Throws:
java.io.IOException

readFully

public void readFully(int[] dest)
               throws java.io.IOException
read data into int array

Parameters:
dest - buffer to store data
Throws:
java.io.IOException

readFully

public void readFully(int[] dest,
                      int byteOrder)
               throws java.io.IOException
read data into int array

Parameters:
dest - buffer to store data
byteOrder - byte order
Throws:
java.io.IOException

readFully

public void readFully(int[] dest,
                      int destOffset,
                      int len)
               throws java.io.IOException
read data into int array

Parameters:
dest - buffer to store data
destOffset - offset in buffer
len - number of ints to read
Throws:
java.io.IOException

readFully

public void readFully(int[] dest,
                      int destOffset,
                      int len,
                      int byteOrder)
               throws java.io.IOException
read data into int array

Parameters:
dest - buffer to store data
destOffset - offset in buffer
len - number of ints to read
byteOrder - byte order
Throws:
java.io.IOException

readFully

public void readFully(long[] dest)
               throws java.io.IOException
read data into long array

Parameters:
dest - buffer to store data
Throws:
java.io.IOException

readFully

public void readFully(long[] dest,
                      int byteOrder)
               throws java.io.IOException
read data into long array

Parameters:
dest - buffer to store data
byteOrder - byte order
Throws:
java.io.IOException

readFully

public void readFully(long[] dest,
                      int destOffset,
                      int len)
               throws java.io.IOException
read data into long array

Parameters:
dest - buffer to store data
destOffset - offset in buffer
len - number of longs to read
Throws:
java.io.IOException

readFully

public void readFully(long[] dest,
                      int destOffset,
                      int len,
                      int byteOrder)
               throws java.io.IOException
read data into long array

Parameters:
dest - buffer to store data
destOffset - offset in buffer
len - number of longs to read
byteOrder - byte order
Throws:
java.io.IOException

readFully

public void readFully(float[] dest)
               throws java.io.IOException
read data into float array

Parameters:
dest - buffer to store data
Throws:
java.io.IOException

readFully

public void readFully(float[] dest,
                      int byteOrder)
               throws java.io.IOException
read data into float array

Parameters:
dest - buffer to store data
byteOrder - byte order
Throws:
java.io.IOException

readFully

public void readFully(float[] dest,
                      int destOffset,
                      int len)
               throws java.io.IOException
read data into float array

Parameters:
dest - buffer to store data
destOffset - offset in buffer
len - number of floats to read
Throws:
java.io.IOException

readFully

public void readFully(float[] dest,
                      int destOffset,
                      int len,
                      int byteOrder)
               throws java.io.IOException
read data into float array

Parameters:
dest - buffer to store data
destOffset - offset in buffer
len - number of floats to read
byteOrder - byte order
Throws:
java.io.IOException

readFully

public void readFully(double[] dest)
               throws java.io.IOException
read data into double array

Parameters:
dest - buffer to store data
Throws:
java.io.IOException

readFully

public void readFully(double[] dest,
                      int byteOrder)
               throws java.io.IOException
read data into double array

Parameters:
dest - buffer to store data
byteOrder - byte order
Throws:
java.io.IOException

readFully

public void readFully(double[] dest,
                      int destOffset,
                      int len)
               throws java.io.IOException
read data into double array

Parameters:
dest - buffer to store data
destOffset - offset in buffer
len - number of doubles to read
Throws:
java.io.IOException

readFully

public void readFully(double[] dest,
                      int destOffset,
                      int len,
                      int byteOrder)
               throws java.io.IOException
read data into double array

Parameters:
dest - buffer to store data
destOffset - offset in buffer
len - number of doubles to read
byteOrder - byte order
Throws:
java.io.IOException

readByteLine

public byte[] readByteLine()
                    throws java.io.IOException
like readLine but returns byte array

Returns:
byte array
Throws:
java.io.IOException