Overview  Package   Class  Tree  Deprecated  Index  Help  Codase Click search sample or example code, search definition, search google 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

javax.imageio.stream
Interface ImageInputStream

All Superinterfaces:
DataInput sample code for java.io.DataInput definition code for java.io.DataInput
All Known Subinterfaces:
ImageOutputStream sample code for javax.imageio.stream.ImageOutputStream definition code for javax.imageio.stream.ImageOutputStream
All Known Implementing Classes:
FileCacheImageInputStream sample code for javax.imageio.stream.FileCacheImageInputStream definition code for javax.imageio.stream.FileCacheImageInputStream , FileCacheImageOutputStream sample code for javax.imageio.stream.FileCacheImageOutputStream definition code for javax.imageio.stream.FileCacheImageOutputStream , FileImageInputStream sample code for javax.imageio.stream.FileImageInputStream definition code for javax.imageio.stream.FileImageInputStream , FileImageOutputStream sample code for javax.imageio.stream.FileImageOutputStream definition code for javax.imageio.stream.FileImageOutputStream , ImageInputStreamImpl sample code for javax.imageio.stream.ImageInputStreamImpl definition code for javax.imageio.stream.ImageInputStreamImpl , ImageOutputStreamImpl sample code for javax.imageio.stream.ImageOutputStreamImpl definition code for javax.imageio.stream.ImageOutputStreamImpl , MemoryCacheImageInputStream sample code for javax.imageio.stream.MemoryCacheImageInputStream definition code for javax.imageio.stream.MemoryCacheImageInputStream , MemoryCacheImageOutputStream sample code for javax.imageio.stream.MemoryCacheImageOutputStream definition code for javax.imageio.stream.MemoryCacheImageOutputStream 
public interface ImageInputStream
extends DataInput sample code for java.io.DataInput definition code for java.io.DataInput

A seekable input stream interface for use by ImageReaders. Various input sources, such as InputStreams and Files, as well as future fast I/O sources may be "wrapped" by a suitable implementation of this interface for use by the Image I/O API.

See Also:
ImageInputStreamImpl sample code for javax.imageio.stream.ImageInputStreamImpl definition code for javax.imageio.stream.ImageInputStreamImpl , FileImageInputStream sample code for javax.imageio.stream.FileImageInputStream definition code for javax.imageio.stream.FileImageInputStream , FileCacheImageInputStream sample code for javax.imageio.stream.FileCacheImageInputStream definition code for javax.imageio.stream.FileCacheImageInputStream , MemoryCacheImageInputStream sample code for javax.imageio.stream.MemoryCacheImageInputStream definition code for javax.imageio.stream.MemoryCacheImageInputStream

Method Summary
 void close sample code for javax.imageio.stream.ImageInputStream.close() definition code for javax.imageio.stream.ImageInputStream.close() ()
          Closes the stream.
 void flush sample code for javax.imageio.stream.ImageInputStream.flush() definition code for javax.imageio.stream.ImageInputStream.flush() ()
          Discards the initial position of the stream prior to the current stream position.
 void flushBefore sample code for javax.imageio.stream.ImageInputStream.flushBefore(long) definition code for javax.imageio.stream.ImageInputStream.flushBefore(long) (long pos)
          Discards the initial portion of the stream prior to the indicated postion.
 int getBitOffset sample code for javax.imageio.stream.ImageInputStream.getBitOffset() definition code for javax.imageio.stream.ImageInputStream.getBitOffset() ()
          Returns the current bit offset, as an integer between 0 and 7, inclusive.
 ByteOrder sample code for java.nio.ByteOrder definition code for java.nio.ByteOrder getByteOrder sample code for javax.imageio.stream.ImageInputStream.getByteOrder() definition code for javax.imageio.stream.ImageInputStream.getByteOrder() ()
          Returns the byte order with which data values will be read from this stream as an instance of the java.nio.ByteOrder enumeration.
 long getFlushedPosition sample code for javax.imageio.stream.ImageInputStream.getFlushedPosition() definition code for javax.imageio.stream.ImageInputStream.getFlushedPosition() ()
          Returns the earliest position in the stream to which seeking may be performed.
 long getStreamPosition sample code for javax.imageio.stream.ImageInputStream.getStreamPosition() definition code for javax.imageio.stream.ImageInputStream.getStreamPosition() ()
          Returns the current byte position of the stream.
 boolean isCached sample code for javax.imageio.stream.ImageInputStream.isCached() definition code for javax.imageio.stream.ImageInputStream.isCached() ()
          Returns true if this ImageInputStream caches data itself in order to allow seeking backwards.
 boolean isCachedFile sample code for javax.imageio.stream.ImageInputStream.isCachedFile() definition code for javax.imageio.stream.ImageInputStream.isCachedFile() ()
          Returns true if this ImageInputStream caches data itself in order to allow seeking backwards, and the cache is kept in a temporary file.
 boolean isCachedMemory sample code for javax.imageio.stream.ImageInputStream.isCachedMemory() definition code for javax.imageio.stream.ImageInputStream.isCachedMemory() ()
          Returns true if this ImageInputStream caches data itself in order to allow seeking backwards, and the cache is kept in main memory.
 long length sample code for javax.imageio.stream.ImageInputStream.length() definition code for javax.imageio.stream.ImageInputStream.length() ()
          Returns the total length of the stream, if known.
 void mark sample code for javax.imageio.stream.ImageInputStream.mark() definition code for javax.imageio.stream.ImageInputStream.mark() ()
          Marks a position in the stream to be returned to by a subsequent call to reset.
 int read sample code for javax.imageio.stream.ImageInputStream.read() definition code for javax.imageio.stream.ImageInputStream.read() ()
          Reads a single byte from the stream and returns it as an integer between 0 and 255.
 int read sample code for javax.imageio.stream.ImageInputStream.read(byte[]) definition code for javax.imageio.stream.ImageInputStream.read(byte[]) (byte[] b)
          Reads up to b.length bytes from the stream, and stores them into b starting at index 0.
 int read sample code for javax.imageio.stream.ImageInputStream.read(byte[], int, int) definition code for javax.imageio.stream.ImageInputStream.read(byte[], int, int) (byte[] b, int off, int len)
          Reads up to len bytes from the stream, and stores them into b starting at index off.
 int readBit sample code for javax.imageio.stream.ImageInputStream.readBit() definition code for javax.imageio.stream.ImageInputStream.readBit() ()
          Reads a single bit from the stream and returns it as an int with the value 0 or 1.
 long readBits sample code for javax.imageio.stream.ImageInputStream.readBits(int) definition code for javax.imageio.stream.ImageInputStream.readBits(int) (int numBits)
          Reads a bitstring from the stream and returns it as a long, with the first bit read becoming the most significant bit of the output.
 boolean readBoolean sample code for javax.imageio.stream.ImageInputStream.readBoolean() definition code for javax.imageio.stream.ImageInputStream.readBoolean() ()
          Reads a byte from the stream and returns a boolean value of true if it is nonzero, false if it is zero.
 byte readByte sample code for javax.imageio.stream.ImageInputStream.readByte() definition code for javax.imageio.stream.ImageInputStream.readByte() ()
          Reads a byte from the stream and returns it as a byte value.
 void readBytes sample code for javax.imageio.stream.ImageInputStream.readBytes(javax.imageio.stream.IIOByteBuffer, int) definition code for javax.imageio.stream.ImageInputStream.readBytes(javax.imageio.stream.IIOByteBuffer, int) (IIOByteBuffer sample code for javax.imageio.stream.IIOByteBuffer definition code for javax.imageio.stream.IIOByteBuffer  buf, int len)
          Reads up to len bytes from the stream, and modifies the supplied IIOByteBuffer to indicate the byte array, offset, and length where the data may be found.
 char readChar sample code for javax.imageio.stream.ImageInputStream.readChar() definition code for javax.imageio.stream.ImageInputStream.readChar() ()
          Equivalent to readUnsignedShort, except that the result is returned using the char datatype.
 double readDouble sample code for javax.imageio.stream.ImageInputStream.readDouble() definition code for javax.imageio.stream.ImageInputStream.readDouble() ()
          Reads 8 bytes from the stream, and (conceptually) concatenates them according to the current byte order and returns the result as a double.
 float readFloat sample code for javax.imageio.stream.ImageInputStream.readFloat() definition code for javax.imageio.stream.ImageInputStream.readFloat() ()
          Reads 4 bytes from the stream, and (conceptually) concatenates them according to the current byte order and returns the result as a float.
 void readFully sample code for javax.imageio.stream.ImageInputStream.readFully(byte[]) definition code for javax.imageio.stream.ImageInputStream.readFully(byte[]) (byte[] b)
          Reads b.length bytes from the stream, and stores them into b starting at index 0.
 void readFully sample code for javax.imageio.stream.ImageInputStream.readFully(byte[], int, int) definition code for javax.imageio.stream.ImageInputStream.readFully(byte[], int, int) (byte[] b, int off, int len)
          Reads len bytes from the stream, and stores them into b starting at index off.
 void readFully sample code for javax.imageio.stream.ImageInputStream.readFully(char[], int, int) definition code for javax.imageio.stream.ImageInputStream.readFully(char[], int, int) (char[] c, int off, int len)
          Reads len chars (unsigned 16-bit integers) from the stream according to the current byte order, and stores them into c starting at index off.
 void readFully sample code for javax.imageio.stream.ImageInputStream.readFully(double[], int, int) definition code for javax.imageio.stream.ImageInputStream.readFully(double[], int, int) (double[] d, int off, int len)
          Reads len doubles (64-bit IEEE double-precision floats) from the stream according to the current byte order, and stores them into d starting at index off.
 void readFully sample code for javax.imageio.stream.ImageInputStream.readFully(float[], int, int) definition code for javax.imageio.stream.ImageInputStream.readFully(float[], int, int) (float[] f, int off, int len)
          Reads len floats (32-bit IEEE single-precision floats) from the stream according to the current byte order, and stores them into f starting at index off.
 void readFully sample code for javax.imageio.stream.ImageInputStream.readFully(int[], int, int) definition code for javax.imageio.stream.ImageInputStream.readFully(int[], int, int) (int[] i, int off, int len)
          Reads len ints (signed 32-bit integers) from the stream according to the current byte order, and stores them into i starting at index off.
 void readFully sample code for javax.imageio.stream.ImageInputStream.readFully(long[], int, int) definition code for javax.imageio.stream.ImageInputStream.readFully(long[], int, int) (long[] l, int off, int len)
          Reads len longs (signed 64-bit integers) from the stream according to the current byte order, and stores them into l starting at index off.
 void readFully sample code for javax.imageio.stream.ImageInputStream.readFully(short[], int, int) definition code for javax.imageio.stream.ImageInputStream.readFully(short[], int, int) (short[] s, int off, int len)
          Reads len shorts (signed 16-bit integers) from the stream according to the current byte order, and stores them into s starting at index off.
 int readInt sample code for javax.imageio.stream.ImageInputStream.readInt() definition code for javax.imageio.stream.ImageInputStream.readInt() ()
          Reads 4 bytes from the stream, and (conceptually) concatenates them according to the current byte order and returns the result as an int.
 String sample code for java.lang.String definition code for java.lang.String readLine sample code for javax.imageio.stream.ImageInputStream.readLine() definition code for javax.imageio.stream.ImageInputStream.readLine() ()
          Reads the next line of text from the input stream.
 long readLong sample code for javax.imageio.stream.ImageInputStream.readLong() definition code for javax.imageio.stream.ImageInputStream.readLong() ()
          Reads 8 bytes from the stream, and (conceptually) concatenates them according to the current byte order and returns the result as a long.
 short readShort sample code for javax.imageio.stream.ImageInputStream.readShort() definition code for javax.imageio.stream.ImageInputStream.readShort() ()
          Reads two bytes from the stream, and (conceptually) concatenates them according to the current byte order, and returns the result as a short value.
 int readUnsignedByte sample code for javax.imageio.stream.ImageInputStream.readUnsignedByte() definition code for javax.imageio.stream.ImageInputStream.readUnsignedByte() ()
          Reads a byte from the stream, and (conceptually) converts it to an int, masks it with 0xff in order to strip off any sign-extension bits, and returns it as a byte value.
 long readUnsignedInt sample code for javax.imageio.stream.ImageInputStream.readUnsignedInt() definition code for javax.imageio.stream.ImageInputStream.readUnsignedInt() ()
          Reads 4 bytes from the stream, and (conceptually) concatenates them according to the current byte order, converts the result to a long, masks it with 0xffffffffL in order to strip off any sign-extension bits, and returns the result as an unsigned long value.
 int readUnsignedShort sample code for javax.imageio.stream.ImageInputStream.readUnsignedShort() definition code for javax.imageio.stream.ImageInputStream.readUnsignedShort() ()
          Reads two bytes from the stream, and (conceptually) concatenates them according to the current byte order, converts the resulting value to an int, masks it with 0xffff in order to strip off any sign-extension buts, and returns the result as an unsigned int value.
 String sample code for java.lang.String definition code for java.lang.String readUTF sample code for javax.imageio.stream.ImageInputStream.readUTF() definition code for javax.imageio.stream.ImageInputStream.readUTF() ()
          Reads in a string that has been encoded using a modified UTF-8 format.
 void reset sample code for javax.imageio.stream.ImageInputStream.reset() definition code for javax.imageio.stream.ImageInputStream.reset() ()
          Returns the file pointer to its previous position, including the bit offset, at the time of the most recent unmatched call to mark.
 void seek sample code for javax.imageio.stream.ImageInputStream.seek(long) definition code for javax.imageio.stream.ImageInputStream.seek(long) (long pos)
          Sets the current stream position to the desired location.
 void setBitOffset sample code for javax.imageio.stream.ImageInputStream.setBitOffset(int) definition code for javax.imageio.stream.ImageInputStream.setBitOffset(int) (int bitOffset)
          Sets the bit offset to an integer between 0 and 7, inclusive.
 void setByteOrder sample code for javax.imageio.stream.ImageInputStream.setByteOrder(java.nio.ByteOrder) definition code for javax.imageio.stream.ImageInputStream.setByteOrder(java.nio.ByteOrder) (ByteOrder sample code for java.nio.ByteOrder definition code for java.nio.ByteOrder  byteOrder)
          Sets the desired byte order for future reads of data values from this stream.
 int skipBytes sample code for javax.imageio.stream.ImageInputStream.skipBytes(int) definition code for javax.imageio.stream.ImageInputStream.skipBytes(int) (int n)
          Moves the stream position forward by a given number of bytes.
 long skipBytes sample code for javax.imageio.stream.ImageInputStream.skipBytes(long) definition code for javax.imageio.stream.ImageInputStream.skipBytes(long) (long n)
          Moves the stream position forward by a given number of bytes.
 

Method Detail

setByteOrder sample code for javax.imageio.stream.ImageInputStream.setByteOrder(java.nio.ByteOrder) definition code for javax.imageio.stream.ImageInputStream.setByteOrder(java.nio.ByteOrder) 

void setByteOrder(ByteOrder sample code for java.nio.ByteOrder definition code for java.nio.ByteOrder  byteOrder)
Sets the desired byte order for future reads of data values from this stream. For example, the sequence of bytes '0x01 0x02 0x03 0x04' if read as a 4-byte integer would have the value '0x01020304' using network byte order and the value '0x04030201' under the reverse byte order.

The enumeration class java.nio.ByteOrder is used to specify the byte order. A value of ByteOrder.BIG_ENDIAN specifies so-called big-endian or network byte order, in which the high-order byte comes first. Motorola and Sparc processors store data in this format, while Intel processors store data in the reverse ByteOrder.LITTLE_ENDIAN order.

The byte order has no effect on the results returned from the readBits method (or the value written by ImageOutputStream.writeBits).

Parameters:
byteOrder - one of ByteOrder.BIG_ENDIAN or java.nio.ByteOrder.LITTLE_ENDIAN, indicating whether network byte order or its reverse will be used for future reads.
See Also:
ByteOrder sample code for java.nio.ByteOrder definition code for java.nio.ByteOrder , getByteOrder() sample code for javax.imageio.stream.ImageInputStream.getByteOrder() definition code for javax.imageio.stream.ImageInputStream.getByteOrder() , readBits(int) sample code for javax.imageio.stream.ImageInputStream.readBits(int) definition code for javax.imageio.stream.ImageInputStream.readBits(int)

getByteOrder sample code for javax.imageio.stream.ImageInputStream.getByteOrder() definition code for javax.imageio.stream.ImageInputStream.getByteOrder() 

ByteOrder sample code for java.nio.ByteOrder definition code for java.nio.ByteOrder  getByteOrder()
Returns the byte order with which data values will be read from this stream as an instance of the java.nio.ByteOrder enumeration.

Returns:
one of ByteOrder.BIG_ENDIAN or ByteOrder.LITTLE_ENDIAN, indicating which byte order is being used.
See Also:
ByteOrder sample code for java.nio.ByteOrder definition code for java.nio.ByteOrder , setByteOrder(java.nio.ByteOrder) sample code for javax.imageio.stream.ImageInputStream.setByteOrder(java.nio.ByteOrder) definition code for javax.imageio.stream.ImageInputStream.setByteOrder(java.nio.ByteOrder)

read sample code for javax.imageio.stream.ImageInputStream.read() definition code for javax.imageio.stream.ImageInputStream.read() 

int read()
         throws IOException sample code for java.io.IOException definition code for java.io.IOException
Reads a single byte from the stream and returns it as an integer between 0 and 255. If the end of the stream is reached, -1 is returned.

The bit offset within the stream is reset to zero before the read occurs.

Returns:
a byte value from the stream, as an int, or -1 to indicate EOF.
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.

read sample code for javax.imageio.stream.ImageInputStream.read(byte[]) definition code for javax.imageio.stream.ImageInputStream.read(byte[]) 

int read(byte[] b)
         throws IOException sample code for java.io.IOException definition code for java.io.IOException
Reads up to b.length bytes from the stream, and stores them into b starting at index 0. The number of bytes read is returned. If no bytes can be read because the end of the stream has been reached, -1 is returned.

The bit offset within the stream is reset to zero before the read occurs.

Parameters:
b - an array of bytes to be written to.
Returns:
the number of bytes actually read, or -1 to indicate EOF.
Throws:
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if b is null.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.

read sample code for javax.imageio.stream.ImageInputStream.read(byte[], int, int) definition code for javax.imageio.stream.ImageInputStream.read(byte[], int, int) 

int read(byte[] b,
         int off,
         int len)
         throws IOException sample code for java.io.IOException definition code for java.io.IOException
Reads up to len bytes from the stream, and stores them into b starting at index off. The number of bytes read is returned. If no bytes can be read because the end of the stream has been reached, -1 is returned.

The bit offset within the stream is reset to zero before the read occurs.

Parameters:
b - an array of bytes to be written to.
off - the starting position within b to write to.
len - the maximum number of bytes to read.
Returns:
the number of bytes actually read, or -1 to indicate EOF.
Throws:
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if b is null.
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - if off is negative, len is negative, or off + len is greater than b.length.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.

readBytes sample code for javax.imageio.stream.ImageInputStream.readBytes(javax.imageio.stream.IIOByteBuffer, int) definition code for javax.imageio.stream.ImageInputStream.readBytes(javax.imageio.stream.IIOByteBuffer, int) 

void readBytes(IIOByteBuffer sample code for javax.imageio.stream.IIOByteBuffer definition code for javax.imageio.stream.IIOByteBuffer  buf,
               int len)
               throws IOException sample code for java.io.IOException definition code for java.io.IOException
Reads up to len bytes from the stream, and modifies the supplied IIOByteBuffer to indicate the byte array, offset, and length where the data may be found. The caller should not attempt to modify the data found in the IIOByteBuffer.

The bit offset within the stream is reset to zero before the read occurs.

Parameters:
buf - an IIOByteBuffer object to be modified.
len - the maximum number of bytes to read.
Throws:
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - if len is negative.
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if buf is null.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.

readBoolean sample code for javax.imageio.stream.ImageInputStream.readBoolean() definition code for javax.imageio.stream.ImageInputStream.readBoolean() 

boolean readBoolean()
                    throws IOException sample code for java.io.IOException definition code for java.io.IOException
Reads a byte from the stream and returns a boolean value of true if it is nonzero, false if it is zero.

The bit offset within the stream is reset to zero before the read occurs.

Specified by:
readBoolean sample code for java.io.DataInput.readBoolean() definition code for java.io.DataInput.readBoolean() in interface DataInput sample code for java.io.DataInput definition code for java.io.DataInput
Returns:
a boolean value from the stream.
Throws:
EOFException sample code for java.io.EOFException definition code for java.io.EOFException - if the end of the stream is reached.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.

readByte sample code for javax.imageio.stream.ImageInputStream.readByte() definition code for javax.imageio.stream.ImageInputStream.readByte() 

byte readByte()
              throws IOException sample code for java.io.IOException definition code for java.io.IOException
Reads a byte from the stream and returns it as a byte value. Byte values between 0x00 and 0x7f represent integer values between 0 and 127. Values between 0x80 and 0xff represent negative values from -128 to /1.

The bit offset within the stream is reset to zero before the read occurs.

Specified by:
readByte sample code for java.io.DataInput.readByte() definition code for java.io.DataInput.readByte() in interface DataInput sample code for java.io.DataInput definition code for java.io.DataInput
Returns:
a signed byte value from the stream.
Throws:
EOFException sample code for java.io.EOFException definition code for java.io.EOFException - if the end of the stream is reached.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.

readUnsignedByte sample code for javax.imageio.stream.ImageInputStream.readUnsignedByte() definition code for javax.imageio.stream.ImageInputStream.readUnsignedByte() 

int readUnsignedByte()
                     throws IOException sample code for java.io.IOException definition code for java.io.IOException
Reads a byte from the stream, and (conceptually) converts it to an int, masks it with 0xff in order to strip off any sign-extension bits, and returns it as a byte value.

Thus, byte values between 0x00 and 0x7f are simply returned as integer values between 0 and 127. Values between 0x80 and 0xff, which normally represent negative bytevalues, will be mapped into positive integers between 128 and 255.

The bit offset within the stream is reset to zero before the read occurs.

Specified by:
readUnsignedByte sample code for java.io.DataInput.readUnsignedByte() definition code for java.io.DataInput.readUnsignedByte() in interface DataInput sample code for java.io.DataInput definition code for java.io.DataInput
Returns:
an unsigned byte value from the stream.
Throws:
EOFException sample code for java.io.EOFException definition code for java.io.EOFException - if the end of the stream is reached.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.

readShort sample code for javax.imageio.stream.ImageInputStream.readShort() definition code for javax.imageio.stream.ImageInputStream.readShort() 

short readShort()
                throws IOException sample code for java.io.IOException definition code for java.io.IOException
Reads two bytes from the stream, and (conceptually) concatenates them according to the current byte order, and returns the result as a short value.

The bit offset within the stream is reset to zero before the read occurs.

Specified by:
readShort sample code for java.io.DataInput.readShort() definition code for java.io.DataInput.readShort() in interface DataInput sample code for java.io.DataInput definition code for java.io.DataInput
Returns:
a signed short value from the stream.
Throws:
EOFException sample code for java.io.EOFException definition code for java.io.EOFException - if the stream reaches the end before reading all the bytes.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.
See Also:
getByteOrder() sample code for javax.imageio.stream.ImageInputStream.getByteOrder() definition code for javax.imageio.stream.ImageInputStream.getByteOrder()

readUnsignedShort sample code for javax.imageio.stream.ImageInputStream.readUnsignedShort() definition code for javax.imageio.stream.ImageInputStream.readUnsignedShort() 

int readUnsignedShort()
                      throws IOException sample code for java.io.IOException definition code for java.io.IOException
Reads two bytes from the stream, and (conceptually) concatenates them according to the current byte order, converts the resulting value to an int, masks it with 0xffff in order to strip off any sign-extension buts, and returns the result as an unsigned int value.

The bit offset within the stream is reset to zero before the read occurs.

Specified by:
readUnsignedShort sample code for java.io.DataInput.readUnsignedShort() definition code for java.io.DataInput.readUnsignedShort() in interface DataInput sample code for java.io.DataInput definition code for java.io.DataInput
Returns:
an unsigned short value from the stream, as an int.
Throws:
EOFException sample code for java.io.EOFException definition code for java.io.EOFException - if the stream reaches the end before reading all the bytes.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.
See Also:
getByteOrder() sample code for javax.imageio.stream.ImageInputStream.getByteOrder() definition code for javax.imageio.stream.ImageInputStream.getByteOrder()

readChar sample code for javax.imageio.stream.ImageInputStream.readChar() definition code for javax.imageio.stream.ImageInputStream.readChar() 

char readChar()
              throws IOException sample code for java.io.IOException definition code for java.io.IOException
Equivalent to readUnsignedShort, except that the result is returned using the char datatype.

The bit offset within the stream is reset to zero before the read occurs.

Specified by:
readChar sample code for java.io.DataInput.readChar() definition code for java.io.DataInput.readChar() in interface DataInput sample code for java.io.DataInput definition code for java.io.DataInput
Returns:
an unsigned char value from the stream.
Throws:
EOFException sample code for java.io.EOFException definition code for java.io.EOFException - if the stream reaches the end before reading all the bytes.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.
See Also:
readUnsignedShort() sample code for javax.imageio.stream.ImageInputStream.readUnsignedShort() definition code for javax.imageio.stream.ImageInputStream.readUnsignedShort()

readInt sample code for javax.imageio.stream.ImageInputStream.readInt() definition code for javax.imageio.stream.ImageInputStream.readInt() 

int readInt()
            throws IOException sample code for java.io.IOException definition code for java.io.IOException
Reads 4 bytes from the stream, and (conceptually) concatenates them according to the current byte order and returns the result as an int.

The bit offset within the stream is ignored and treated as though it were zero.

Specified by:
readInt sample code for java.io.DataInput.readInt() definition code for java.io.DataInput.readInt() in interface DataInput sample code for java.io.DataInput definition code for java.io.DataInput
Returns:
a signed int value from the stream.
Throws:
EOFException sample code for java.io.EOFException definition code for java.io.EOFException - if the stream reaches the end before reading all the bytes.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.
See Also:
getByteOrder() sample code for javax.imageio.stream.ImageInputStream.getByteOrder() definition code for javax.imageio.stream.ImageInputStream.getByteOrder()

readUnsignedInt sample code for javax.imageio.stream.ImageInputStream.readUnsignedInt() definition code for javax.imageio.stream.ImageInputStream.readUnsignedInt() 

long readUnsignedInt()
                     throws IOException sample code for java.io.IOException definition code for java.io.IOException
Reads 4 bytes from the stream, and (conceptually) concatenates them according to the current byte order, converts the result to a long, masks it with 0xffffffffL in order to strip off any sign-extension bits, and returns the result as an unsigned long value.

The bit offset within the stream is reset to zero before the read occurs.

Returns:
an unsigned int value from the stream, as a long.
Throws:
EOFException sample code for java.io.EOFException definition code for java.io.EOFException - if the stream reaches the end before reading all the bytes.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.
See Also:
getByteOrder() sample code for javax.imageio.stream.ImageInputStream.getByteOrder() definition code for javax.imageio.stream.ImageInputStream.getByteOrder()

readLong sample code for javax.imageio.stream.ImageInputStream.readLong() definition code for javax.imageio.stream.ImageInputStream.readLong() 

long readLong()
              throws IOException sample code for java.io.IOException definition code for java.io.IOException
Reads 8 bytes from the stream, and (conceptually) concatenates them according to the current byte order and returns the result as a long.

The bit offset within the stream is reset to zero before the read occurs.

Specified by:
readLong sample code for java.io.DataInput.readLong() definition code for java.io.DataInput.readLong() in interface DataInput sample code for java.io.DataInput definition code for java.io.DataInput
Returns:
a signed long value from the stream.
Throws:
EOFException sample code for java.io.EOFException definition code for java.io.EOFException - if the stream reaches the end before reading all the bytes.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.
See Also:
getByteOrder() sample code for javax.imageio.stream.ImageInputStream.getByteOrder() definition code for javax.imageio.stream.ImageInputStream.getByteOrder()

readFloat sample code for javax.imageio.stream.ImageInputStream.readFloat() definition code for javax.imageio.stream.ImageInputStream.readFloat() 

float readFloat()
                throws IOException sample code for java.io.IOException definition code for java.io.IOException
Reads 4 bytes from the stream, and (conceptually) concatenates them according to the current byte order and returns the result as a float.

The bit offset within the stream is reset to zero before the read occurs.

Specified by:
readFloat sample code for java.io.DataInput.readFloat() definition code for java.io.DataInput.readFloat() in interface DataInput sample code for java.io.DataInput definition code for java.io.DataInput
Returns:
a float value from the stream.
Throws:
EOFException sample code for java.io.EOFException definition code for java.io.EOFException - if the stream reaches the end before reading all the bytes.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.
See Also:
getByteOrder() sample code for javax.imageio.stream.ImageInputStream.getByteOrder() definition code for javax.imageio.stream.ImageInputStream.getByteOrder()

readDouble sample code for javax.imageio.stream.ImageInputStream.readDouble() definition code for javax.imageio.stream.ImageInputStream.readDouble() 

double readDouble()
                  throws IOException sample code for java.io.IOException definition code for java.io.IOException
Reads 8 bytes from the stream, and (conceptually) concatenates them according to the current byte order and returns the result as a double.

The bit offset within the stream is reset to zero before the read occurs.

Specified by:
readDouble sample code for java.io.DataInput.readDouble() definition code for java.io.DataInput.readDouble() in interface DataInput sample code for java.io.DataInput definition code for java.io.DataInput
Returns:
a double value from the stream.
Throws:
EOFException sample code for java.io.EOFException definition code for java.io.EOFException - if the stream reaches the end before reading all the bytes.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.
See Also:
getByteOrder() sample code for javax.imageio.stream.ImageInputStream.getByteOrder() definition code for javax.imageio.stream.ImageInputStream.getByteOrder()

readLine sample code for javax.imageio.stream.ImageInputStream.readLine() definition code for javax.imageio.stream.ImageInputStream.readLine() 

String sample code for java.lang.String definition code for java.lang.String  readLine()
                throws IOException sample code for java.io.IOException definition code for java.io.IOException
Reads the next line of text from the input stream. It reads successive bytes, converting each byte separately into a character, until it encounters a line terminator or end of file; the characters read are then returned as a String. Note that because this method processes bytes, it does not support input of the full Unicode character set.

If end of file is encountered before even one byte can be read, then null is returned. Otherwise, each byte that is read is converted to type char by zero-extension. If the character '\n' is encountered, it is discarded and reading ceases. If the character '\r' is encountered, it is discarded and, if the following byte converts to the character '\n', then that is discarded also; reading then ceases. If end of file is encountered before either of the characters '\n' and '\r' is encountered, reading ceases. Once reading has ceased, a String is returned that contains all the characters read and not discarded, taken in order. Note that every character in this string will have a value less than \u0100, that is, (char)256.

The bit offset within the stream is reset to zero before the read occurs.

Specified by:
readLine sample code for java.io.DataInput.readLine() definition code for java.io.DataInput.readLine() in interface DataInput sample code for java.io.DataInput definition code for java.io.DataInput
Returns:
a String containing a line of text from the stream.
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.

readUTF sample code for javax.imageio.stream.ImageInputStream.readUTF() definition code for javax.imageio.stream.ImageInputStream.readUTF() 

String sample code for java.lang.String definition code for java.lang.String  readUTF()
               throws IOException sample code for java.io.IOException definition code for java.io.IOException
Reads in a string that has been encoded using a modified UTF-8 format. The general contract of readUTF is that it reads a representation of a Unicode character string encoded in modified UTF-8 format; this string of characters is then returned as a String.

First, two bytes are read and used to construct an unsigned 16-bit integer in the manner of the readUnsignedShort method, using network byte order (regardless of the current byte order setting). This integer value is called the UTF length and specifies the number of additional bytes to be read. These bytes are then converted to characters by considering them in groups. The length of each group is computed from the value of the first byte of the group. The byte following a group, if any, is the first byte of the next group.

If the first byte of a group matches the bit pattern 0xxxxxxx (where x means "may be 0 or 1"), then the group consists of just that byte. The byte is zero-extended to form a character.

If the first byte of a group matches the bit pattern 110xxxxx, then the group consists of that byte a and a second byte b. If there is no byte b (because byte a was the last of the bytes to be read), or if byte b does not match the bit pattern 10xxxxxx, then a UTFDataFormatException is thrown. Otherwise, the group is converted to the character: 


 (char)(((a& 0x1F) << 6) | (b & 0x3F))
If the first byte of a group matches the bit pattern 1110xxxx, then the group consists of that byte a and two more bytes b and c. If there is no byte c (because byte a was one of the last two of the bytes to be read), or either byte b or byte c does not match the bit pattern 10xxxxxx, then a UTFDataFormatException is thrown. Otherwise, the group is converted to the character: 


 (char)(((a & 0x0F) << 12) | ((b & 0x3F) << 6) | (c & 0x3F))
If the first byte of a group matches the pattern 1111xxxx or the pattern 10xxxxxx, then a UTFDataFormatException is thrown.

If end of file is encountered at any time during this entire process, then an EOFException is thrown.

After every group has been converted to a character by this process, the characters are gathered, in the same order in which their corresponding groups were read from the input stream, to form a String, which is returned.

The current byte order setting is ignored.

The bit offset within the stream is reset to zero before the read occurs.

Note: This method should not be used in the implementation of image formats that use standard UTF-8, because the modified UTF-8 used here is incompatible with standard UTF-8.

Specified by:
readUTF sample code for java.io.DataInput.readUTF() definition code for java.io.DataInput.readUTF() in interface DataInput sample code for java.io.DataInput definition code for java.io.DataInput
Returns:
a String read from the stream.
Throws:
EOFException sample code for java.io.EOFException definition code for java.io.EOFException - if this stream reaches the end before reading all the bytes.
UTFDataFormatException sample code for java.io.UTFDataFormatException definition code for java.io.UTFDataFormatException - if the bytes do not represent a valid modified UTF-8 encoding of a string.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.

readFully sample code for javax.imageio.stream.ImageInputStream.readFully(byte[], int, int) definition code for javax.imageio.stream.ImageInputStream.readFully(byte[], int, int) 

void readFully(byte[] b,
               int off,
               int len)
               throws IOException sample code for java.io.IOException definition code for java.io.IOException
Reads len bytes from the stream, and stores them into b starting at index off. If the end of the stream is reached, an EOFException will be thrown.

The bit offset within the stream is reset to zero before the read occurs.

Specified by:
readFully sample code for java.io.DataInput.readFully(byte[], int, int) definition code for java.io.DataInput.readFully(byte[], int, int) in interface DataInput sample code for java.io.DataInput definition code for java.io.DataInput
Parameters:
b - an array of bytes to be written to.
off - the starting position within b to write to.
len - the maximum number of bytes to read.
Throws:
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - if off is negative, len is negative, or off + len is greater than b.length.
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if b is null.
EOFException sample code for java.io.EOFException definition code for java.io.EOFException - if the stream reaches the end before reading all the bytes.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.

readFully sample code for javax.imageio.stream.ImageInputStream.readFully(byte[]) definition code for javax.imageio.stream.ImageInputStream.readFully(byte[]) 

void readFully(byte[] b)
               throws IOException sample code for java.io.IOException definition code for java.io.IOException
Reads b.length bytes from the stream, and stores them into b starting at index 0. If the end of the stream is reached, an EOFException will be thrown.

The bit offset within the stream is reset to zero before the read occurs.

Specified by:
readFully sample code for java.io.DataInput.readFully(byte[]) definition code for java.io.DataInput.readFully(byte[]) in interface DataInput sample code for java.io.DataInput definition code for java.io.DataInput
Parameters:
b - an array of bytes.
Throws:
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if b is null.
EOFException sample code for java.io.EOFException definition code for java.io.EOFException - if the stream reaches the end before reading all the bytes.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.

readFully sample code for javax.imageio.stream.ImageInputStream.readFully(short[], int, int) definition code for javax.imageio.stream.ImageInputStream.readFully(short[], int, int) 

void readFully(short[] s,
               int off,
               int len)
               throws IOException sample code for java.io.IOException definition code for java.io.IOException
Reads len shorts (signed 16-bit integers) from the stream according to the current byte order, and stores them into s starting at index off. If the end of the stream is reached, an EOFException will be thrown.

The bit offset within the stream is reset to zero before the read occurs.

Parameters:
s - an array of shorts to be written to.
off - the starting position withinb to write to.
len - the maximum number of shorts to read.
Throws:
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - if off is negative, len is negative, or off + len is greater than s.length.
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if s is null.
EOFException sample code for java.io.EOFException definition code for java.io.EOFException - if the stream reaches the end before reading all the bytes.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.

readFully sample code for javax.imageio.stream.ImageInputStream.readFully(char[], int, int) definition code for javax.imageio.stream.ImageInputStream.readFully(char[], int, int) 

void readFully(char[] c,
               int off,
               int len)
               throws IOException sample code for java.io.IOException definition code for java.io.IOException
Reads len chars (unsigned 16-bit integers) from the stream according to the current byte order, and stores them into c starting at index off. If the end of the stream is reached, an EOFException will be thrown.

The bit offset within the stream is reset to zero before the read occurs.

Parameters:
c - an array of chars to be written to.
off - the starting position withinb to write to.
len - the maximum number of chars to read.
Throws:
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - if off is negative, len is negative, or off + len is greater than c.length.
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if c is null.
EOFException sample code for java.io.EOFException definition code for java.io.EOFException - if the stream reaches the end before reading all the bytes.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.

readFully sample code for javax.imageio.stream.ImageInputStream.readFully(int[], int, int) definition code for javax.imageio.stream.ImageInputStream.readFully(int[], int, int) 

void readFully(int[] i,
               int off,
               int len)
               throws IOException sample code for java.io.IOException definition code for java.io.IOException
Reads len ints (signed 32-bit integers) from the stream according to the current byte order, and stores them into i starting at index off. If the end of the stream is reached, an EOFException will be thrown.

The bit offset within the stream is reset to zero before the read occurs.

Parameters:
i - an array of ints to be written to.
off - the starting position withinb to write to.
len - the maximum number of ints to read.
Throws:
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - if off is negative, len is negative, or off + len is greater than i.length.
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if i is null.
EOFException sample code for java.io.EOFException definition code for java.io.EOFException - if the stream reaches the end before reading all the bytes.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.

readFully sample code for javax.imageio.stream.ImageInputStream.readFully(long[], int, int) definition code for javax.imageio.stream.ImageInputStream.readFully(long[], int, int) 

void readFully(long[] l,
               int off,
               int len)
               throws IOException sample code for java.io.IOException definition code for java.io.IOException
Reads len longs (signed 64-bit integers) from the stream according to the current byte order, and stores them into l starting at index off. If the end of the stream is reached, an EOFException will be thrown.

The bit offset within the stream is reset to zero before the read occurs.

Parameters:
l - an array of longs to be written to.
off - the starting position withinb to write to.
len - the maximum number of longs to read.
Throws:
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - if off is negative, len is negative, or off + len is greater than l.length.
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if l is null.
EOFException sample code for java.io.EOFException definition code for java.io.EOFException - if the stream reaches the end before reading all the bytes.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.

readFully sample code for javax.imageio.stream.ImageInputStream.readFully(float[], int, int) definition code for javax.imageio.stream.ImageInputStream.readFully(float[], int, int) 

void readFully(float[] f,
               int off,
               int len)
               throws IOException sample code for java.io.IOException definition code for java.io.IOException
Reads len floats (32-bit IEEE single-precision floats) from the stream according to the current byte order, and stores them into f starting at index off. If the end of the stream is reached, an EOFException will be thrown.

The bit offset within the stream is reset to zero before the read occurs.

Parameters:
f - an array of floats to be written to.
off - the starting position withinb to write to.
len - the maximum number of floats to read.
Throws:
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - if off is negative, len is negative, or off + len is greater than f.length.
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if f is null.
EOFException sample code for java.io.EOFException definition code for java.io.EOFException - if the stream reaches the end before reading all the bytes.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.

readFully sample code for javax.imageio.stream.ImageInputStream.readFully(double[], int, int) definition code for javax.imageio.stream.ImageInputStream.readFully(double[], int, int) 

void readFully(double[] d,
               int off,
               int len)
               throws IOException sample code for java.io.IOException definition code for java.io.IOException
Reads len doubles (64-bit IEEE double-precision floats) from the stream according to the current byte order, and stores them into d starting at index off. If the end of the stream is reached, an EOFException will be thrown.

The bit offset within the stream is reset to zero before the read occurs.

Parameters:
d - an array of doubles to be written to.
off - the starting position withinb to write to.
len - the maximum number of doubles to read.
Throws:
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - if off is negative, len is negative, or off + len is greater than d.length.
NullPointerException sample code for java.lang.NullPointerException definition code for java.lang.NullPointerException - if d is null.
EOFException sample code for java.io.EOFException definition code for java.io.EOFException - if the stream reaches the end before reading all the bytes.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.

getStreamPosition sample code for javax.imageio.stream.ImageInputStream.getStreamPosition() definition code for javax.imageio.stream.ImageInputStream.getStreamPosition() 

long getStreamPosition()
                       throws IOException sample code for java.io.IOException definition code for java.io.IOException
Returns the current byte position of the stream. The next read will take place starting at this offset.

Returns:
a long containing the position of the stream.
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.

getBitOffset sample code for javax.imageio.stream.ImageInputStream.getBitOffset() definition code for javax.imageio.stream.ImageInputStream.getBitOffset() 

int getBitOffset()
                 throws IOException sample code for java.io.IOException definition code for java.io.IOException
Returns the current bit offset, as an integer between 0 and 7, inclusive. The bit offset is updated implicitly by calls to the readBits method. A value of 0 indicates the most-significant bit, and a value of 7 indicates the least significant bit, of the byte being read.

The bit offset is set to 0 when a stream is first opened, and is reset to 0 by calls to seek, skipBytes, or any read or readFully method.

Returns:
an int containing the bit offset between 0 and 7, inclusive.
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.
See Also:
setBitOffset(int) sample code for javax.imageio.stream.ImageInputStream.setBitOffset(int) definition code for javax.imageio.stream.ImageInputStream.setBitOffset(int)

setBitOffset sample code for javax.imageio.stream.ImageInputStream.setBitOffset(int) definition code for javax.imageio.stream.ImageInputStream.setBitOffset(int) 

void setBitOffset(int bitOffset)
                  throws IOException sample code for java.io.IOException definition code for java.io.IOException
Sets the bit offset to an integer between 0 and 7, inclusive. The byte offset within the stream, as returned by getStreamPosition, is left unchanged. A value of 0 indicates the most-significant bit, and a value of 7 indicates the least significant bit, of the byte being read.

Parameters:
bitOffset - the desired offset, as an int between 0 and 7, inclusive.
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if bitOffset is not between 0 and 7, inclusive.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.
See Also:
getBitOffset() sample code for javax.imageio.stream.ImageInputStream.getBitOffset() definition code for javax.imageio.stream.ImageInputStream.getBitOffset()

readBit sample code for javax.imageio.stream.ImageInputStream.readBit() definition code for javax.imageio.stream.ImageInputStream.readBit() 

int readBit()
            throws IOException sample code for java.io.IOException definition code for java.io.IOException
Reads a single bit from the stream and returns it as an int with the value 0 or 1. The bit offset is advanced by one and reduced modulo 8.

Returns:
an int containing the value 0 or 1.
Throws:
EOFException sample code for java.io.EOFException definition code for java.io.EOFException - if the stream reaches the end before reading all the bits.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.

readBits sample code for javax.imageio.stream.ImageInputStream.readBits(int) definition code for javax.imageio.stream.ImageInputStream.readBits(int) 

long readBits(int numBits)
              throws IOException sample code for java.io.IOException definition code for java.io.IOException
Reads a bitstring from the stream and returns it as a long, with the first bit read becoming the most significant bit of the output. The read starts within the byte indicated by getStreamPosition, at the bit given by getBitOffset. The bit offset is advanced by numBits and reduced modulo 8.

The byte order of the stream has no effect on this method. The return value of this method is constructed as though the bits were read one at a time, and shifted into the right side of the return value, as shown by the following pseudo-code: 

 long accum = 0L;
 for (int i = 0; i < numBits; i++) {
   accum <<= 1; // Shift left one bit to make room
   accum |= readBit();
 }
Note that the result of readBits(32) may thus not be equal to that of readInt() if a reverse network byte order is being used (i.e., getByteOrder() == false).

If the end of the stream is encountered before all the bits have been read, an EOFException is thrown.

Parameters:
numBits - the number of bits to read, as an int between 0 and 64, inclusive.
Returns:
the bitstring, as a long with the last bit read stored in the least significant bit.
Throws:
IllegalArgumentException sample code for java.lang.IllegalArgumentException definition code for java.lang.IllegalArgumentException - if numBits is not between 0 and 64, inclusive.
EOFException sample code for java.io.EOFException definition code for java.io.EOFException - if the stream reaches the end before reading all the bits.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.

length sample code for javax.imageio.stream.ImageInputStream.length() definition code for javax.imageio.stream.ImageInputStream.length() 

long length()
            throws IOException sample code for java.io.IOException definition code for java.io.IOException
Returns the total length of the stream, if known. Otherwise, -1 is returned.

Returns:
a long containing the length of the stream, if known, or else -1.
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.

skipBytes sample code for javax.imageio.stream.ImageInputStream.skipBytes(int) definition code for javax.imageio.stream.ImageInputStream.skipBytes(int) 

int skipBytes(int n)
              throws IOException sample code for java.io.IOException definition code for java.io.IOException
Moves the stream position forward by a given number of bytes. It is possible that this method will only be able to skip forward by a smaller number of bytes than requested, for example if the end of the stream is reached. In all cases, the actual number of bytes skipped is returned. The bit offset is set to zero prior to advancing the position.

Specified by:
skipBytes sample code for java.io.DataInput.skipBytes(int) definition code for java.io.DataInput.skipBytes(int) in interface DataInput sample code for java.io.DataInput definition code for java.io.DataInput
Parameters:
n - an int containing the number of bytes to be skipped.
Returns:
an int representing the number of bytes skipped.
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.

skipBytes sample code for javax.imageio.stream.ImageInputStream.skipBytes(long) definition code for javax.imageio.stream.ImageInputStream.skipBytes(long) 

long skipBytes(long n)
               throws IOException sample code for java.io.IOException definition code for java.io.IOException
Moves the stream position forward by a given number of bytes. This method is identical to skipBytes(int) except that it allows for a larger skip distance.

Parameters:
n - a long containing the number of bytes to be skipped.
Returns:
a long representing the number of bytes skipped.
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.

seek sample code for javax.imageio.stream.ImageInputStream.seek(long) definition code for javax.imageio.stream.ImageInputStream.seek(long) 

void seek(long pos)
          throws IOException sample code for java.io.IOException definition code for java.io.IOException
Sets the current stream position to the desired location. The next read will occur at this location. The bit offset is set to 0.

An IndexOutOfBoundsException will be thrown if pos is smaller than the flushed position (as returned by getflushedPosition).

It is legal to seek past the end of the file; an EOFException will be thrown only if a read is performed.

Parameters:
pos - a long containing the desired file pointer position.
Throws:
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - if pos is smaller than the flushed position.
IOException sample code for java.io.IOException definition code for java.io.IOException - if any other I/O error occurs.

mark sample code for javax.imageio.stream.ImageInputStream.mark() definition code for javax.imageio.stream.ImageInputStream.mark() 

void mark()
Marks a position in the stream to be returned to by a subsequent call to reset. Unlike a standard InputStream, all ImageInputStreams support marking. Additionally, calls to mark and reset may be nested arbitrarily.

Unlike the mark methods declared by the Reader InputStream interfaces, no readLimit parameter is used. An arbitrary amount of data may be read following the call to mark.

The bit position used by the readBits method is saved and restored by each pair of calls to mark and reset.

reset sample code for javax.imageio.stream.ImageInputStream.reset() definition code for javax.imageio.stream.ImageInputStream.reset() 

void reset()
           throws IOException sample code for java.io.IOException definition code for java.io.IOException
Returns the file pointer to its previous position, including the bit offset, at the time of the most recent unmatched call to mark.

Calls to reset without a corresponding call to mark have no effect.

An IOException will be thrown if the previous marked position lies in the discarded portion of the stream.

Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.

flushBefore sample code for javax.imageio.stream.ImageInputStream.flushBefore(long) definition code for javax.imageio.stream.ImageInputStream.flushBefore(long) 

void flushBefore(long pos)
                 throws IOException sample code for java.io.IOException definition code for java.io.IOException
Discards the initial portion of the stream prior to the indicated postion. Attempting to seek to an offset within the flushed portion of the stream will result in an IndexOutOfBoundsException.

Calling flushBefore may allow classes implementing this interface to free up resources such as memory or disk space that are being used to store data from the stream.

Parameters:
pos - a long containing the length of the file prefix that may be flushed.
Throws:
IndexOutOfBoundsException sample code for java.lang.IndexOutOfBoundsException definition code for java.lang.IndexOutOfBoundsException - if pos lies in the flushed portion of the stream or past the current stream position.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.

flush sample code for javax.imageio.stream.ImageInputStream.flush() definition code for javax.imageio.stream.ImageInputStream.flush() 

void flush()
           throws IOException sample code for java.io.IOException definition code for java.io.IOException
Discards the initial position of the stream prior to the current stream position. Equivalent to flushBefore(getStreamPosition()).

Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.

getFlushedPosition sample code for javax.imageio.stream.ImageInputStream.getFlushedPosition() definition code for javax.imageio.stream.ImageInputStream.getFlushedPosition() 

long getFlushedPosition()
Returns the earliest position in the stream to which seeking may be performed. The returned value will be the maximum of all values passed into previous calls to flushBefore.

Returns:
the earliest legal position for seeking, as a long.

isCached sample code for javax.imageio.stream.ImageInputStream.isCached() definition code for javax.imageio.stream.ImageInputStream.isCached() 

boolean isCached()
Returns true if this ImageInputStream caches data itself in order to allow seeking backwards. Applications may consult this in order to decide how frequently, or whether, to flush in order to conserve cache resources.

Returns:
true if this ImageInputStream caches data.
See Also:
isCachedMemory() sample code for javax.imageio.stream.ImageInputStream.isCachedMemory() definition code for javax.imageio.stream.ImageInputStream.isCachedMemory() , isCachedFile() sample code for javax.imageio.stream.ImageInputStream.isCachedFile() definition code for javax.imageio.stream.ImageInputStream.isCachedFile()

isCachedMemory sample code for javax.imageio.stream.ImageInputStream.isCachedMemory() definition code for javax.imageio.stream.ImageInputStream.isCachedMemory() 

boolean isCachedMemory()
Returns true if this ImageInputStream caches data itself in order to allow seeking backwards, and the cache is kept in main memory. Applications may consult this in order to decide how frequently, or whether, to flush in order to conserve cache resources.

Returns:
true if this ImageInputStream caches data in main memory.
See Also:
isCached() sample code for javax.imageio.stream.ImageInputStream.isCached() definition code for javax.imageio.stream.ImageInputStream.isCached() , isCachedFile() sample code for javax.imageio.stream.ImageInputStream.isCachedFile() definition code for javax.imageio.stream.ImageInputStream.isCachedFile()

isCachedFile sample code for javax.imageio.stream.ImageInputStream.isCachedFile() definition code for javax.imageio.stream.ImageInputStream.isCachedFile() 

boolean isCachedFile()
Returns true if this ImageInputStream caches data itself in order to allow seeking backwards, and the cache is kept in a temporary file. Applications may consult this in order to decide how frequently, or whether, to flush in order to conserve cache resources.

Returns:
true if this ImageInputStream caches data in a temporary file.
See Also:
isCached() sample code for javax.imageio.stream.ImageInputStream.isCached() definition code for javax.imageio.stream.ImageInputStream.isCached() , isCachedMemory() sample code for javax.imageio.stream.ImageInputStream.isCachedMemory() definition code for javax.imageio.stream.ImageInputStream.isCachedMemory()

close sample code for javax.imageio.stream.ImageInputStream.close() definition code for javax.imageio.stream.ImageInputStream.close() 

void close()
           throws IOException sample code for java.io.IOException definition code for java.io.IOException
Closes the stream. Attempts to access a stream that has been closed may result in IOExceptions or incorrect behavior. Calling this method may allow classes implementing this interface to release resources associated with the stream such as memory, disk space, or file descriptors.

Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.
Overview  Package   Class  Tree  Deprecated  Index  Help  Codase Click search sample or example code, search definition, search google 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD