FileDocCategorySizeDatePackage
ImageInputStream.javaAPI DocAndroid 1.5 API15137Wed May 06 22:41:54 BST 2009javax.imageio.stream

ImageInputStream

public interface ImageInputStream implements DataInput
The ImageInputStream represents input stream interface that is used by ImageReaders.
since
Android 1.0

Fields Summary
Constructors Summary
Methods Summary
public voidclose()
Closes this stream.

throws
IOException if an I/O exception has occurred.

public voidflush()
Flushes the initial position in this stream prior to the current stream position.

throws
IOException if an I/O exception has occurred.

public voidflushBefore(long pos)
Flushes the initial position in this stream prior to the specified stream position.

param
pos the position.
throws
IOException if an I/O exception has occurred.

public intgetBitOffset()
Gets the bit offset.

return
the bit offset.
throws
IOException if an I/O exception has occurred.

public java.nio.ByteOrdergetByteOrder()
Gets the byte order.

return
the byte order.

public longgetFlushedPosition()
Gets the flushed position.

return
the flushed position.

public longgetStreamPosition()
Gets the stream position.

return
the stream position.
throws
IOException if an I/O exception has occurred.

public booleanisCached()
Returns true if this ImageInputStream caches data in order to allow seeking backwards.

return
true, if this ImageInputStream caches data in order to allow seeking backwards, false otherwise.

public booleanisCachedFile()
Returns true if this ImageInputStream caches data in order to allow seeking backwards, and keeps it in a temporary file.

return
true, if this ImageInputStream caches data in order to allow seeking backwards, and keeps it in a temporary file.

public booleanisCachedMemory()
Returns true if this ImageInputStream caches data in order to allow seeking backwards, and keeps it in memory.

return
true, if this ImageInputStream caches data in order to allow seeking backwards, and keeps it in memory.

public longlength()
Returns the length of the stream.

return
the length of the stream, or -1 if unknown.
throws
IOException if an I/O exception has occurred.

public voidmark()
Marks a position in the stream to be returned to by a subsequent call to reset.

public intread()
Reads a byte from the stream.

return
the byte of the stream, or -1 for EOF indicating.
throws
IOException if an I/O exception has occurred.

public intread(byte[] b)
Reads number of bytes which is equal to the specified array's length and stores a result to this array.

param
b the byte array.
return
the number of read bytes, or -1 indicated EOF.
throws
IOException if an I/O exception has occurred.

public intread(byte[] b, int off, int len)
Reads the number of bytes specified by len parameter from the stream and stores a result to the specified array with the specified offset.

param
b the byte array.
param
off the offset.
param
len the number of bytes to be read.
return
the number of read bytes, or -1 indicated EOF.
throws
IOException if an I/O exception has occurred.

public intreadBit()
Reads a bit from the stream and returns the value 0 or 1.

return
the value of single bit: 0 or 1.
throws
IOException if an I/O exception has occurred.

public longreadBits(int numBits)
Read the specified number of bits and returns their values as long.

param
numBits the number of bits to be read.
return
the bit string as a long.
throws
IOException if an I/O exception has occurred.

public booleanreadBoolean()
Reads a byte from the stream and returns a boolean true value if it is non zero, false if it is zero.

return
the boolean value for read byte.
throws
IOException if an I/O exception has occurred.

public bytereadByte()
Reads a byte from the stream and returns its value as signed byte.

return
the signed byte value for read byte.
throws
IOException if an I/O exception has occurred.

public voidreadBytes(javax.imageio.stream.IIOByteBuffer buf, int len)
Reads the number of bytes specified by len parameter from the stream, and modifies the specified IIOByteBuffer with the byte array, offset, and length.

param
buf the IIOByteBuffer.
param
len the number of bytes to be read.
throws
IOException if an I/O exception has occurred.

public charreadChar()
Reads 2 bytes from the stream and returns their unsigned char value.

return
the unsigned char value.
throws
IOException if an I/O exception has occurred.

public doublereadDouble()
Reads 8 bytes from the stream, and returns the result as a double.

return
the double value from the stream.
throws
IOException if an I/O exception has occurred.

public floatreadFloat()
Reads 4 bytes from the stream, and returns the result as a float.

return
the float value from the stream.
throws
IOException if an I/O exception has occurred.

public voidreadFully(byte[] b, int off, int len)
Reads the specified number of bytes from the stream, and stores the result into the specified array starting at the specified index offset.

param
b the byte array.
param
off the offset.
param
len the number of bytes to be read.
throws
IOException if an I/O exception has occurred.

public voidreadFully(byte[] b)
Reads number of bytes from the stream which is equal to the specified array's length, and stores them into this array.

param
b the byte array.
throws
IOException if an I/O exception has occurred.

public voidreadFully(short[] s, int off, int len)
Reads the specified number of shorts from the stream, and stores the result into the specified array starting at the specified index offset.

param
s the short array.
param
off the offset.
param
len the number of shorts to be read.
throws
IOException if an I/O exception has occurred.

public voidreadFully(char[] c, int off, int len)
Reads the specified number of chars from the stream, and stores the result into the specified array starting at the specified index offset.

param
c the char array.
param
off the offset.
param
len the number of chars to be read.
throws
IOException if an I/O exception has occurred.

public voidreadFully(int[] i, int off, int len)
Reads the specified number of integer from the stream, and stores the result into the specified array starting at the specified index offset.

param
i the integer array.
param
off the offset.
param
len the number of integer to be read.
throws
IOException if an I/O exception has occurred.

public voidreadFully(long[] l, int off, int len)
Reads the specified number of longs from the stream, and stores the result into the specified array starting at the specified index offset.

param
l the long array.
param
off the offset.
param
len the number of longs to be read.
throws
IOException if an I/O exception has occurred.

public voidreadFully(float[] f, int off, int len)
Reads the specified number of floats from the stream, and stores the result into the specified array starting at the specified index offset.

param
f the float array.
param
off the offset.
param
len the number of floats to be read.
throws
IOException if an I/O exception has occurred.

public voidreadFully(double[] d, int off, int len)
Reads the specified number of doubles from the stream, and stores the result into the specified array starting at the specified index offset.

param
d the double array.
param
off the offset.
param
len the number of doubles to be read.
throws
IOException if an I/O exception has occurred.

public intreadInt()
Reads 4 bytes from the stream, and returns the result as an integer.

return
the signed integer value from the stream.
throws
IOException if an I/O exception has occurred.

public java.lang.StringreadLine()
Reads a line from the stream.

return
the string contained the line from the stream.
throws
IOException if an I/O exception has occurred.

public longreadLong()
Reads 8 bytes from the stream, and returns the result as a long.

return
the long value from the stream.
throws
IOException if an I/O exception has occurred.

public shortreadShort()
Reads 2 bytes from the stream, and returns the result as a short.

return
the signed short value from the stream.
throws
IOException if an I/O exception has occurred.

public java.lang.StringreadUTF()
Reads bytes from the stream in a string that has been encoded in a modified UTF-8 format.

return
the string read from stream and modified UTF-8 format.
throws
IOException if an I/O exception has occurred.

public intreadUnsignedByte()
Reads a byte from the stream and returns its value as an integer.

return
the unsigned byte value for read byte as an integer.
throws
IOException if an I/O exception has occurred.

public longreadUnsignedInt()
Reads 4 bytes from the stream and returns its value as long.

return
the unsigned integer value as long.
throws
IOException if an I/O exception has occurred.

public intreadUnsignedShort()
Reads 2 bytes from the stream and returns its value as an unsigned short.

return
a unsigned short value coded in an integer.
throws
IOException if an I/O exception has occurred.

public voidreset()
Returns the file pointer to its previous position.

throws
IOException if an I/O exception has occurred.

public voidseek(long pos)
Sets the current stream position to the specified location.

param
pos a file pointer position.
throws
IOException if an I/O exception has occurred.

public voidsetBitOffset(int bitOffset)
Sets the bit offset to an integer between 0 and 7.

param
bitOffset the bit offset.
throws
IOException if an I/O exception has occurred.

public voidsetByteOrder(java.nio.ByteOrder byteOrder)
Sets the specified byte order for reading of data values from this stream.

param
byteOrder the byte order.

public intskipBytes(int n)
Skips the specified number of bytes by moving stream position.

param
n the number of bytes.
return
the actual skipped number of bytes.
throws
IOException if an I/O exception has occurred.

public longskipBytes(long n)
Skips the specified number of bytes by moving stream position.

param
n the number of bytes.
return
the actual skipped number of bytes.
throws
IOException if an I/O exception has occurred.