javax.imageio.stream
Class ImageInputStreamImpl

java.lang.Object sample code for java.lang.Object definition code for java.lang.Object 
  extended by javax.imageio.stream.ImageInputStreamImpl
All Implemented Interfaces:
DataInput sample code for java.io.DataInput definition code for java.io.DataInput , ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
Direct Known Subclasses:
FileCacheImageInputStream sample code for javax.imageio.stream.FileCacheImageInputStream definition code for javax.imageio.stream.FileCacheImageInputStream , FileImageInputStream sample code for javax.imageio.stream.FileImageInputStream definition code for javax.imageio.stream.FileImageInputStream , 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

public abstract class ImageInputStreamImpl
extends Object sample code for java.lang.Object definition code for java.lang.Object
implements ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream

An abstract class implementing the ImageInputStream interface. This class is designed to reduce the number of methods that must be implemented by subclasses.

In particular, this class handles most or all of the details of byte order interpretation, buffering, mark/reset, discarding, closing, and disposing.


Field Summary
protected  int bitOffset sample code for javax.imageio.stream.ImageInputStreamImpl.bitOffset definition code for javax.imageio.stream.ImageInputStreamImpl.bitOffset
          The current bit offset within the stream.
protected  ByteOrder sample code for java.nio.ByteOrder definition code for java.nio.ByteOrder byteOrder sample code for javax.imageio.stream.ImageInputStreamImpl.byteOrder definition code for javax.imageio.stream.ImageInputStreamImpl.byteOrder
          The byte order of the stream as an instance of the enumeration class java.nio.ByteOrder, where ByteOrder.BIG_ENDIAN indicates network byte order and ByteOrder.LITTLE_ENDIAN indicates the reverse order.
protected  long flushedPos sample code for javax.imageio.stream.ImageInputStreamImpl.flushedPos definition code for javax.imageio.stream.ImageInputStreamImpl.flushedPos
          The position prior to which data may be discarded.
protected  long streamPos sample code for javax.imageio.stream.ImageInputStreamImpl.streamPos definition code for javax.imageio.stream.ImageInputStreamImpl.streamPos
          The current read position within the stream.
 
Constructor Summary
ImageInputStreamImpl sample code for javax.imageio.stream.ImageInputStreamImpl.ImageInputStreamImpl() definition code for javax.imageio.stream.ImageInputStreamImpl.ImageInputStreamImpl() ()
          Constructs an ImageInputStreamImpl.
 
Method Summary
protected  void checkClosed sample code for javax.imageio.stream.ImageInputStreamImpl.checkClosed() definition code for javax.imageio.stream.ImageInputStreamImpl.checkClosed() ()
          Throws an IOException if the stream has been closed.
 void close sample code for javax.imageio.stream.ImageInputStreamImpl.close() definition code for javax.imageio.stream.ImageInputStreamImpl.close() ()
          Closes the stream.
protected  void finalize sample code for javax.imageio.stream.ImageInputStreamImpl.finalize() definition code for javax.imageio.stream.ImageInputStreamImpl.finalize() ()
          Finalizes this object prior to garbage collection.
 void flush sample code for javax.imageio.stream.ImageInputStreamImpl.flush() definition code for javax.imageio.stream.ImageInputStreamImpl.flush() ()
          Discards the initial position of the stream prior to the current stream position.
 void flushBefore sample code for javax.imageio.stream.ImageInputStreamImpl.flushBefore(long) definition code for javax.imageio.stream.ImageInputStreamImpl.flushBefore(long) (long pos)
          Discards the initial portion of the stream prior to the indicated postion.
 int getBitOffset sample code for javax.imageio.stream.ImageInputStreamImpl.getBitOffset() definition code for javax.imageio.stream.ImageInputStreamImpl.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.ImageInputStreamImpl.getByteOrder() definition code for javax.imageio.stream.ImageInputStreamImpl.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.ImageInputStreamImpl.getFlushedPosition() definition code for javax.imageio.stream.ImageInputStreamImpl.getFlushedPosition() ()
          Returns the earliest position in the stream to which seeking may be performed.
 long getStreamPosition sample code for javax.imageio.stream.ImageInputStreamImpl.getStreamPosition() definition code for javax.imageio.stream.ImageInputStreamImpl.getStreamPosition() ()
          Returns the current byte position of the stream.
 boolean isCached sample code for javax.imageio.stream.ImageInputStreamImpl.isCached() definition code for javax.imageio.stream.ImageInputStreamImpl.isCached() ()
          Default implementation returns false.
 boolean isCachedFile sample code for javax.imageio.stream.ImageInputStreamImpl.isCachedFile() definition code for javax.imageio.stream.ImageInputStreamImpl.isCachedFile() ()
          Default implementation returns false.
 boolean isCachedMemory sample code for javax.imageio.stream.ImageInputStreamImpl.isCachedMemory() definition code for javax.imageio.stream.ImageInputStreamImpl.isCachedMemory() ()
          Default implementation returns false.
 long length sample code for javax.imageio.stream.ImageInputStreamImpl.length() definition code for javax.imageio.stream.ImageInputStreamImpl.length() ()
          Returns -1L to indicate that the stream has unknown length.
 void mark sample code for javax.imageio.stream.ImageInputStreamImpl.mark() definition code for javax.imageio.stream.ImageInputStreamImpl.mark() ()
          Pushes the current stream position onto a stack of marked positions.
abstract  int read sample code for javax.imageio.stream.ImageInputStreamImpl.read() definition code for javax.imageio.stream.ImageInputStreamImpl.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.ImageInputStreamImpl.read(byte[]) definition code for javax.imageio.stream.ImageInputStreamImpl.read(byte[]) (byte[] b)
          A convenience method that calls read(b, 0, b.length).
abstract  int read sample code for javax.imageio.stream.ImageInputStreamImpl.read(byte[], int, int) definition code for javax.imageio.stream.ImageInputStreamImpl.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.ImageInputStreamImpl.readBit() definition code for javax.imageio.stream.ImageInputStreamImpl.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.ImageInputStreamImpl.readBits(int) definition code for javax.imageio.stream.ImageInputStreamImpl.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.ImageInputStreamImpl.readBoolean() definition code for javax.imageio.stream.ImageInputStreamImpl.readBoolean() ()
          Reads one input byte and returns true if that byte is nonzero, false if that byte is zero.
 byte readByte sample code for javax.imageio.stream.ImageInputStreamImpl.readByte() definition code for javax.imageio.stream.ImageInputStreamImpl.readByte() ()
          Reads and returns one input byte.
 void readBytes sample code for javax.imageio.stream.ImageInputStreamImpl.readBytes(javax.imageio.stream.IIOByteBuffer, int) definition code for javax.imageio.stream.ImageInputStreamImpl.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.ImageInputStreamImpl.readChar() definition code for javax.imageio.stream.ImageInputStreamImpl.readChar() ()
          Reads an input char and returns the char value.
 double readDouble sample code for javax.imageio.stream.ImageInputStreamImpl.readDouble() definition code for javax.imageio.stream.ImageInputStreamImpl.readDouble() ()
          Reads eight input bytes and returns a double value.
 float readFloat sample code for javax.imageio.stream.ImageInputStreamImpl.readFloat() definition code for javax.imageio.stream.ImageInputStreamImpl.readFloat() ()
          Reads four input bytes and returns a float value.
 void readFully sample code for javax.imageio.stream.ImageInputStreamImpl.readFully(byte[]) definition code for javax.imageio.stream.ImageInputStreamImpl.readFully(byte[]) (byte[] b)
          Reads some bytes from an input stream and stores them into the buffer array b.
 void readFully sample code for javax.imageio.stream.ImageInputStreamImpl.readFully(byte[], int, int) definition code for javax.imageio.stream.ImageInputStreamImpl.readFully(byte[], int, int) (byte[] b, int off, int len)
          Reads len bytes from an input stream.
 void readFully sample code for javax.imageio.stream.ImageInputStreamImpl.readFully(char[], int, int) definition code for javax.imageio.stream.ImageInputStreamImpl.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.ImageInputStreamImpl.readFully(double[], int, int) definition code for javax.imageio.stream.ImageInputStreamImpl.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.ImageInputStreamImpl.readFully(float[], int, int) definition code for javax.imageio.stream.ImageInputStreamImpl.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.ImageInputStreamImpl.readFully(int[], int, int) definition code for javax.imageio.stream.ImageInputStreamImpl.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.ImageInputStreamImpl.readFully(long[], int, int) definition code for javax.imageio.stream.ImageInputStreamImpl.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.ImageInputStreamImpl.readFully(short[], int, int) definition code for javax.imageio.stream.ImageInputStreamImpl.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.ImageInputStreamImpl.readInt() definition code for javax.imageio.stream.ImageInputStreamImpl.readInt() ()
          Reads four input bytes and returns an int value.
 String sample code for java.lang.String definition code for java.lang.String readLine sample code for javax.imageio.stream.ImageInputStreamImpl.readLine() definition code for javax.imageio.stream.ImageInputStreamImpl.readLine() ()
          Reads the next line of text from the input stream.
 long readLong sample code for javax.imageio.stream.ImageInputStreamImpl.readLong() definition code for javax.imageio.stream.ImageInputStreamImpl.readLong() ()
          Reads eight input bytes and returns a long value.
 short readShort sample code for javax.imageio.stream.ImageInputStreamImpl.readShort() definition code for javax.imageio.stream.ImageInputStreamImpl.readShort() ()
          Reads two input bytes and returns a short value.
 int readUnsignedByte sample code for javax.imageio.stream.ImageInputStreamImpl.readUnsignedByte() definition code for javax.imageio.stream.ImageInputStreamImpl.readUnsignedByte() ()
          Reads one input byte, zero-extends it to type int, and returns the result, which is therefore in the range 0 through 255.
 long readUnsignedInt sample code for javax.imageio.stream.ImageInputStreamImpl.readUnsignedInt() definition code for javax.imageio.stream.ImageInputStreamImpl.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.ImageInputStreamImpl.readUnsignedShort() definition code for javax.imageio.stream.ImageInputStreamImpl.readUnsignedShort() ()
          Reads two input bytes and returns an int value in the range 0 through 65535.
 String sample code for java.lang.String definition code for java.lang.String readUTF sample code for javax.imageio.stream.ImageInputStreamImpl.readUTF() definition code for javax.imageio.stream.ImageInputStreamImpl.readUTF() ()
          Reads in a string that has been encoded using a modified UTF-8 format.
 void reset sample code for javax.imageio.stream.ImageInputStreamImpl.reset() definition code for javax.imageio.stream.ImageInputStreamImpl.reset() ()
          Resets the current stream byte and bit positions from the stack of marked positions.
 void seek sample code for javax.imageio.stream.ImageInputStreamImpl.seek(long) definition code for javax.imageio.stream.ImageInputStreamImpl.seek(long) (long pos)
          Sets the current stream position to the desired location.
 void setBitOffset sample code for javax.imageio.stream.ImageInputStreamImpl.setBitOffset(int) definition code for javax.imageio.stream.ImageInputStreamImpl.setBitOffset(int) (int bitOffset)
          Sets the bit offset to an integer between 0 and 7, inclusive.
 void setByteOrder sample code for javax.imageio.stream.ImageInputStreamImpl.setByteOrder(java.nio.ByteOrder) definition code for javax.imageio.stream.ImageInputStreamImpl.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.ImageInputStreamImpl.skipBytes(int) definition code for javax.imageio.stream.ImageInputStreamImpl.skipBytes(int) (int n)
          Advances the current stream position by calling seek(getStreamPosition() + n).
 long skipBytes sample code for javax.imageio.stream.ImageInputStreamImpl.skipBytes(long) definition code for javax.imageio.stream.ImageInputStreamImpl.skipBytes(long) (long n)
          Advances the current stream position by calling seek(getStreamPosition() + n).
 
Methods inherited from class java.lang.Object sample code for java.lang.Object definition code for java.lang.Object
clone sample code for java.lang.Object.clone() definition code for java.lang.Object.clone() , equals sample code for java.lang.Object.equals(java.lang.Object) definition code for java.lang.Object.equals(java.lang.Object) , getClass sample code for java.lang.Object.getClass() definition code for java.lang.Object.getClass() , hashCode sample code for java.lang.Object.hashCode() definition code for java.lang.Object.hashCode() , notify sample code for java.lang.Object.notify() definition code for java.lang.Object.notify() , notifyAll sample code for java.lang.Object.notifyAll() definition code for java.lang.Object.notifyAll() , toString sample code for java.lang.Object.toString() definition code for java.lang.Object.toString() , wait sample code for java.lang.Object.wait() definition code for java.lang.Object.wait() , wait sample code for java.lang.Object.wait(long) definition code for java.lang.Object.wait(long) , wait sample code for java.lang.Object.wait(long, int) definition code for java.lang.Object.wait(long, int)
 

Field Detail

byteOrder sample code for javax.imageio.stream.ImageInputStreamImpl.byteOrder

protected ByteOrder sample code for java.nio.ByteOrder definition code for java.nio.ByteOrder  byteOrder
The byte order of the stream as an instance of the enumeration class java.nio.ByteOrder, where ByteOrder.BIG_ENDIAN indicates network byte order and ByteOrder.LITTLE_ENDIAN indicates the reverse order. By default, the value is ByteOrder.BIG_ENDIAN.


streamPos sample code for javax.imageio.stream.ImageInputStreamImpl.streamPos

protected long streamPos
The current read position within the stream. Subclasses are responsible for keeping this value current from any method they override that alters the read position.


bitOffset sample code for javax.imageio.stream.ImageInputStreamImpl.bitOffset

protected int bitOffset
The current bit offset within the stream. Subclasses are responsible for keeping this value current from any method they override that alters the bit offset.


flushedPos sample code for javax.imageio.stream.ImageInputStreamImpl.flushedPos

protected long flushedPos
The position prior to which data may be discarded. Seeking to a smaller position is not allowed. flushedPos will always be >= 0.

Constructor Detail

ImageInputStreamImpl sample code for javax.imageio.stream.ImageInputStreamImpl() definition code for javax.imageio.stream.ImageInputStreamImpl()

public ImageInputStreamImpl()
Constructs an ImageInputStreamImpl.

Method Detail

checkClosed sample code for javax.imageio.stream.ImageInputStreamImpl.checkClosed() definition code for javax.imageio.stream.ImageInputStreamImpl.checkClosed()

protected final void checkClosed()
                          throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Throws an IOException if the stream has been closed. Subclasses may call this method from any of their methods that require the stream not to be closed.

Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if the stream is closed.

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

public void setByteOrder(ByteOrder sample code for java.nio.ByteOrder definition code for java.nio.ByteOrder  byteOrder)
Description copied from interface: ImageInputStream sample code for javax.imageio.stream.ImageInputStream.setByteOrder(java.nio.ByteOrder) definition code for javax.imageio.stream.ImageInputStream.setByteOrder(java.nio.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).

Specified by:
setByteOrder sample code for javax.imageio.stream.ImageInputStream.setByteOrder(java.nio.ByteOrder) definition code for javax.imageio.stream.ImageInputStream.setByteOrder(java.nio.ByteOrder) in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
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 , ImageInputStream.getByteOrder() sample code for javax.imageio.stream.ImageInputStream.getByteOrder() definition code for javax.imageio.stream.ImageInputStream.getByteOrder() , ImageInputStream.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.ImageInputStreamImpl.getByteOrder() definition code for javax.imageio.stream.ImageInputStreamImpl.getByteOrder()

public ByteOrder sample code for java.nio.ByteOrder definition code for java.nio.ByteOrder  getByteOrder()
Description copied from interface: ImageInputStream 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.

Specified by:
getByteOrder sample code for javax.imageio.stream.ImageInputStream.getByteOrder() definition code for javax.imageio.stream.ImageInputStream.getByteOrder() in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
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 , ImageInputStream.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.ImageInputStreamImpl.read() definition code for javax.imageio.stream.ImageInputStreamImpl.read()

public abstract int read()
                  throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Description copied from interface: ImageInputStream 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. 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.

Specified by:
read sample code for javax.imageio.stream.ImageInputStream.read() definition code for javax.imageio.stream.ImageInputStream.read() in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
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.ImageInputStreamImpl.read(byte[]) definition code for javax.imageio.stream.ImageInputStreamImpl.read(byte[])

public int read(byte[] b)
         throws IOException sample code for java.io.IOException definition code for java.io.IOException 
A convenience method that calls read(b, 0, b.length).

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

Specified by:
read sample code for javax.imageio.stream.ImageInputStream.read(byte[]) definition code for javax.imageio.stream.ImageInputStream.read(byte[]) in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
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.ImageInputStreamImpl.read(byte[], int, int) definition code for javax.imageio.stream.ImageInputStreamImpl.read(byte[], int, int)

public abstract 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. If no bytes can be read because the end of the stream has been reached, -1 is returned.

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

Subclasses must provide an implementation for this method. The subclass implementation should update the stream position before exiting.

Specified by:
read sample code for javax.imageio.stream.ImageInputStream.read(byte[], int, int) definition code for javax.imageio.stream.ImageInputStream.read(byte[], int, int) in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
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:
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.
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.ImageInputStreamImpl.readBytes(javax.imageio.stream.IIOByteBuffer, int) definition code for javax.imageio.stream.ImageInputStreamImpl.readBytes(javax.imageio.stream.IIOByteBuffer, int)

public 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 
Description copied from interface: ImageInputStream 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)
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.

Specified by:
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) in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
Parameters:
buf - an IIOByteBuffer object to be modified.
len - the maximum number of bytes to read.
Throws:
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.ImageInputStreamImpl.readBoolean() definition code for javax.imageio.stream.ImageInputStreamImpl.readBoolean()

public boolean readBoolean()
                    throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Description copied from interface: DataInput sample code for java.io.DataInput.readBoolean() definition code for java.io.DataInput.readBoolean()
Reads one input byte and returns true if that byte is nonzero, false if that byte is zero. This method is suitable for reading the byte written by the writeBoolean method of interface DataOutput.

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
Specified by:
readBoolean sample code for javax.imageio.stream.ImageInputStream.readBoolean() definition code for javax.imageio.stream.ImageInputStream.readBoolean() in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
Returns:
the boolean value read.
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.
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.ImageInputStreamImpl.readByte() definition code for javax.imageio.stream.ImageInputStreamImpl.readByte()

public byte readByte()
              throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Description copied from interface: DataInput sample code for java.io.DataInput.readByte() definition code for java.io.DataInput.readByte()
Reads and returns one input byte. The byte is treated as a signed value in the range -128 through 127, inclusive. This method is suitable for reading the byte written by the writeByte method of interface DataOutput.

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
Specified by:
readByte sample code for javax.imageio.stream.ImageInputStream.readByte() definition code for javax.imageio.stream.ImageInputStream.readByte() in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
Returns:
the 8-bit value read.
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.
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.ImageInputStreamImpl.readUnsignedByte() definition code for javax.imageio.stream.ImageInputStreamImpl.readUnsignedByte()

public int readUnsignedByte()
                     throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Description copied from interface: DataInput sample code for java.io.DataInput.readUnsignedByte() definition code for java.io.DataInput.readUnsignedByte()
Reads one input byte, zero-extends it to type int, and returns the result, which is therefore in the range 0 through 255. This method is suitable for reading the byte written by the writeByte method of interface DataOutput if the argument to writeByte was intended to be a value in the range 0 through 255.

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
Specified by:
readUnsignedByte sample code for javax.imageio.stream.ImageInputStream.readUnsignedByte() definition code for javax.imageio.stream.ImageInputStream.readUnsignedByte() in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
Returns:
the unsigned 8-bit value read.
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.
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.ImageInputStreamImpl.readShort() definition code for javax.imageio.stream.ImageInputStreamImpl.readShort()

public short readShort()
                throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Description copied from interface: DataInput sample code for java.io.DataInput.readShort() definition code for java.io.DataInput.readShort()
Reads two input bytes and returns a short value. Let a be the first byte read and b be the second byte. The value returned is:

(short)((a << 8) | (b & 0xff))
 
This method is suitable for reading the bytes written by the writeShort method of interface DataOutput.

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
Specified by:
readShort sample code for javax.imageio.stream.ImageInputStream.readShort() definition code for javax.imageio.stream.ImageInputStream.readShort() in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
Returns:
the 16-bit value read.
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.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.
See Also:
ImageInputStream.getByteOrder() sample code for javax.imageio.stream.ImageInputStream.getByteOrder() definition code for javax.imageio.stream.ImageInputStream.getByteOrder()

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

public int readUnsignedShort()
                      throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Description copied from interface: DataInput sample code for java.io.DataInput.readUnsignedShort() definition code for java.io.DataInput.readUnsignedShort()
Reads two input bytes and returns an int value in the range 0 through 65535. Let a be the first byte read and b be the second byte. The value returned is:

(((a & 0xff) << 8) | (b & 0xff))
 
This method is suitable for reading the bytes written by the writeShort method of interface DataOutput if the argument to writeShort was intended to be a value in the range 0 through 65535.

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
Specified by:
readUnsignedShort sample code for javax.imageio.stream.ImageInputStream.readUnsignedShort() definition code for javax.imageio.stream.ImageInputStream.readUnsignedShort() in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
Returns:
the unsigned 16-bit value read.
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.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.
See Also:
ImageInputStream.getByteOrder() sample code for javax.imageio.stream.ImageInputStream.getByteOrder() definition code for javax.imageio.stream.ImageInputStream.getByteOrder()

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

public char readChar()
              throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Description copied from interface: DataInput sample code for java.io.DataInput.readChar() definition code for java.io.DataInput.readChar()
Reads an input char and returns the char value. A Unicode char is made up of two bytes. Let a be the first byte read and b be the second byte. The value returned is:

(char)((a << 8) | (b & 0xff))
 
This method is suitable for reading bytes written by the writeChar method of interface DataOutput.

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
Specified by:
readChar sample code for javax.imageio.stream.ImageInputStream.readChar() definition code for javax.imageio.stream.ImageInputStream.readChar() in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
Returns:
the Unicode char read.
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.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.
See Also:
ImageInputStream.readUnsignedShort() sample code for javax.imageio.stream.ImageInputStream.readUnsignedShort() definition code for javax.imageio.stream.ImageInputStream.readUnsignedShort()

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

public int readInt()
            throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Description copied from interface: DataInput sample code for java.io.DataInput.readInt() definition code for java.io.DataInput.readInt()
Reads four input bytes and returns an int value. Let a be the first byte read, b be the second byte, c be the third byte, and d be the fourth byte. The value returned is:

 
 (((a & 0xff) << 24) | ((b & 0xff) << 16) |
  ((c & 0xff) << 8) | (d & 0xff))
 
This method is suitable for reading bytes written by the writeInt method of interface DataOutput.

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
Specified by:
readInt sample code for javax.imageio.stream.ImageInputStream.readInt() definition code for javax.imageio.stream.ImageInputStream.readInt() in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
Returns:
the int value read.
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.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.
See Also:
ImageInputStream.getByteOrder() sample code for javax.imageio.stream.ImageInputStream.getByteOrder() definition code for javax.imageio.stream.ImageInputStream.getByteOrder()

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

public long readUnsignedInt()
                     throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Description copied from interface: ImageInputStream 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.

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

Specified by:
readUnsignedInt sample code for javax.imageio.stream.ImageInputStream.readUnsignedInt() definition code for javax.imageio.stream.ImageInputStream.readUnsignedInt() in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
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:
ImageInputStream.getByteOrder() sample code for javax.imageio.stream.ImageInputStream.getByteOrder() definition code for javax.imageio.stream.ImageInputStream.getByteOrder()

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

public long readLong()
              throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Description copied from interface: DataInput sample code for java.io.DataInput.readLong() definition code for java.io.DataInput.readLong()
Reads eight input bytes and returns a long value. Let a be the first byte read, b be the second byte, c be the third byte, d be the fourth byte, e be the fifth byte, f be the sixth byte, g be the seventh byte, and h be the eighth byte. The value returned is:

 
 (((long)(a & 0xff) << 56) |
  ((long)(b & 0xff) << 48) |
  ((long)(c & 0xff) << 40) |
  ((long)(d & 0xff) << 32) |
  ((long)(e & 0xff) << 24) |
  ((long)(f & 0xff) << 16) |
  ((long)(g & 0xff) <<  8) |
  ((long)(h & 0xff)))
 

This method is suitable for reading bytes written by the writeLong method of interface DataOutput.

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
Specified by:
readLong sample code for javax.imageio.stream.ImageInputStream.readLong() definition code for javax.imageio.stream.ImageInputStream.readLong() in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
Returns:
the long value read.
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.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.
See Also:
ImageInputStream.getByteOrder() sample code for javax.imageio.stream.ImageInputStream.getByteOrder() definition code for javax.imageio.stream.ImageInputStream.getByteOrder()

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

public float readFloat()
                throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Description copied from interface: DataInput sample code for java.io.DataInput.readFloat() definition code for java.io.DataInput.readFloat()
Reads four input bytes and returns a float value. It does this by first constructing an int value in exactly the manner of the readInt method, then converting this int value to a float in exactly the manner of the method Float.intBitsToFloat. This method is suitable for reading bytes written by the writeFloat method of interface DataOutput.

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
Specified by:
readFloat sample code for javax.imageio.stream.ImageInputStream.readFloat() definition code for javax.imageio.stream.ImageInputStream.readFloat() in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
Returns:
the float value read.
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.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.
See Also:
ImageInputStream.getByteOrder() sample code for javax.imageio.stream.ImageInputStream.getByteOrder() definition code for javax.imageio.stream.ImageInputStream.getByteOrder()

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

public double readDouble()
                  throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Description copied from interface: DataInput sample code for java.io.DataInput.readDouble() definition code for java.io.DataInput.readDouble()
Reads eight input bytes and returns a double value. It does this by first constructing a long value in exactly the manner of the readlong method, then converting this long value to a double in exactly the manner of the method Double.longBitsToDouble. This method is suitable for reading bytes written by the writeDouble method of interface DataOutput.

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
Specified by:
readDouble sample code for javax.imageio.stream.ImageInputStream.readDouble() definition code for javax.imageio.stream.ImageInputStream.readDouble() in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
Returns:
the double value read.
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.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.
See Also:
ImageInputStream.getByteOrder() sample code for javax.imageio.stream.ImageInputStream.getByteOrder() definition code for javax.imageio.stream.ImageInputStream.getByteOrder()

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

public 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 
Description copied from interface: DataInput sample code for java.io.DataInput.readLine() definition code for java.io.DataInput.readLine()
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.

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
Specified by:
readLine sample code for javax.imageio.stream.ImageInputStream.readLine() definition code for javax.imageio.stream.ImageInputStream.readLine() in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
Returns:
the next line of text from the input stream, or null if the end of file is encountered before a byte can be read.
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.ImageInputStreamImpl.readUTF() definition code for javax.imageio.stream.ImageInputStreamImpl.readUTF()

public 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 
Description copied from interface: DataInput sample code for java.io.DataInput.readUTF() definition code for java.io.DataInput.readUTF()
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 exactly the manner of the readUnsignedShort method . 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 writeUTF method of interface DataOutput may be used to write data that is suitable for reading by this method.

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
Specified by:
readUTF sample code for javax.imageio.stream.ImageInputStream.readUTF() definition code for javax.imageio.stream.ImageInputStream.readUTF() in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
Returns:
a Unicode string.
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.
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.
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.

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

public void readFully(byte[] b,
                      int off,
                      int len)
               throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Description copied from interface: DataInput sample code for java.io.DataInput.readFully(byte[], int, int) definition code for java.io.DataInput.readFully(byte[], int, int)
Reads len bytes from an input stream.

This method blocks until one of the following conditions occurs:

If b is null, a NullPointerException is thrown. If off is negative, or len is negative, or off+len is greater than the length of the array b, then an IndexOutOfBoundsException is thrown. If len is zero, then no bytes are read. Otherwise, the first byte read is stored into element b[off], the next one into b[off+1], and so on. The number of bytes read is, at most, equal to len.

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
Specified by:
readFully sample code for javax.imageio.stream.ImageInputStream.readFully(byte[], int, int) definition code for javax.imageio.stream.ImageInputStream.readFully(byte[], int, int) in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
Parameters:
b - the buffer into which the data is read.
off - an int specifying the offset into the data.
len - an int specifying the number of bytes to read.
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.
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.ImageInputStreamImpl.readFully(byte[]) definition code for javax.imageio.stream.ImageInputStreamImpl.readFully(byte[])

public void readFully(byte[] b)
               throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Description copied from interface: DataInput sample code for java.io.DataInput.readFully(byte[]) definition code for java.io.DataInput.readFully(byte[])
Reads some bytes from an input stream and stores them into the buffer array b. The number of bytes read is equal to the length of b.

This method blocks until one of the following conditions occurs:

If b is null, a NullPointerException is thrown. If b.length is zero, then no bytes are read. Otherwise, the first byte read is stored into element b[0], the next one into b[1], and so on. If an exception is thrown from this method, then it may be that some but not all bytes of b have been updated with data from the input stream.

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
Specified by:
readFully sample code for javax.imageio.stream.ImageInputStream.readFully(byte[]) definition code for javax.imageio.stream.ImageInputStream.readFully(byte[]) in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
Parameters:
b - the buffer into which the data is read.
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.
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.ImageInputStreamImpl.readFully(short[], int, int) definition code for javax.imageio.stream.ImageInputStreamImpl.readFully(short[], int, int)

public void readFully(short[] s,
                      int off,
                      int len)
               throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Description copied from interface: ImageInputStream sample code for javax.imageio.stream.ImageInputStream.readFully(short[], int, int) definition code for javax.imageio.stream.ImageInputStream.readFully(short[], int, int)
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.

Specified by:
readFully sample code for javax.imageio.stream.ImageInputStream.readFully(short[], int, int) definition code for javax.imageio.stream.ImageInputStream.readFully(short[], int, int) in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
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:
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.ImageInputStreamImpl.readFully(char[], int, int) definition code for javax.imageio.stream.ImageInputStreamImpl.readFully(char[], int, int)

public void readFully(char[] c,
                      int off,
                      int len)
               throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Description copied from interface: ImageInputStream sample code for javax.imageio.stream.ImageInputStream.readFully(char[], int, int) definition code for javax.imageio.stream.ImageInputStream.readFully(char[], int, int)
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.

Specified by:
readFully sample code for javax.imageio.stream.ImageInputStream.readFully(char[], int, int) definition code for javax.imageio.stream.ImageInputStream.readFully(char[], int, int) in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
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:
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.ImageInputStreamImpl.readFully(int[], int, int) definition code for javax.imageio.stream.ImageInputStreamImpl.readFully(int[], int, int)

public void readFully(int[] i,
                      int off,
                      int len)
               throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Description copied from interface: ImageInputStream sample code for javax.imageio.stream.ImageInputStream.readFully(int[], int, int) definition code for javax.imageio.stream.ImageInputStream.readFully(int[], int, int)
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.

Specified by:
readFully sample code for javax.imageio.stream.ImageInputStream.readFully(int[], int, int) definition code for javax.imageio.stream.ImageInputStream.readFully(int[], int, int) in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
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:
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.ImageInputStreamImpl.readFully(long[], int, int) definition code for javax.imageio.stream.ImageInputStreamImpl.readFully(long[], int, int)

public void readFully(long[] l,
                      int off,
                      int len)
               throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Description copied from interface: ImageInputStream sample code for javax.imageio.stream.ImageInputStream.readFully(long[], int, int) definition code for javax.imageio.stream.ImageInputStream.readFully(long[], int, int)
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.

Specified by:
readFully sample code for javax.imageio.stream.ImageInputStream.readFully(long[], int, int) definition code for javax.imageio.stream.ImageInputStream.readFully(long[], int, int) in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
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:
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.ImageInputStreamImpl.readFully(float[], int, int) definition code for javax.imageio.stream.ImageInputStreamImpl.readFully(float[], int, int)

public void readFully(float[] f,
                      int off,
                      int len)
               throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Description copied from interface: ImageInputStream sample code for javax.imageio.stream.ImageInputStream.readFully(float[], int, int) definition code for javax.imageio.stream.ImageInputStream.readFully(float[], int, int)
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.

Specified by:
readFully sample code for javax.imageio.stream.ImageInputStream.readFully(float[], int, int) definition code for javax.imageio.stream.ImageInputStream.readFully(float[], int, int) in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
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:
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.ImageInputStreamImpl.readFully(double[], int, int) definition code for javax.imageio.stream.ImageInputStreamImpl.readFully(double[], int, int)

public void readFully(double[] d,
                      int off,
                      int len)
               throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Description copied from interface: ImageInputStream sample code for javax.imageio.stream.ImageInputStream.readFully(double[], int, int) definition code for javax.imageio.stream.ImageInputStream.readFully(double[], int, int)
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.

Specified by:
readFully sample code for javax.imageio.stream.ImageInputStream.readFully(double[], int, int) definition code for javax.imageio.stream.ImageInputStream.readFully(double[], int, int) in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
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:
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.ImageInputStreamImpl.getStreamPosition() definition code for javax.imageio.stream.ImageInputStreamImpl.getStreamPosition()

public long getStreamPosition()
                       throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Description copied from interface: ImageInputStream sample code for javax.imageio.stream.ImageInputStream.getStreamPosition() definition code for javax.imageio.stream.ImageInputStream.getStreamPosition()
Returns the current byte position of the stream. The next read will take place starting at this offset.

Specified by:
getStreamPosition sample code for javax.imageio.stream.ImageInputStream.getStreamPosition() definition code for javax.imageio.stream.ImageInputStream.getStreamPosition() in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
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.ImageInputStreamImpl.getBitOffset() definition code for javax.imageio.stream.ImageInputStreamImpl.getBitOffset()

public int getBitOffset()
                 throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Description copied from interface: ImageInputStream 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. 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.

Specified by:
getBitOffset sample code for javax.imageio.stream.ImageInputStream.getBitOffset() definition code for javax.imageio.stream.ImageInputStream.getBitOffset() in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
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:
ImageInputStream.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.ImageInputStreamImpl.setBitOffset(int) definition code for javax.imageio.stream.ImageInputStreamImpl.setBitOffset(int)

public void setBitOffset(int bitOffset)
                  throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Description copied from interface: ImageInputStream sample code for javax.imageio.stream.ImageInputStream.setBitOffset(int) definition code for javax.imageio.stream.ImageInputStream.setBitOffset(int)
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.

Specified by:
setBitOffset sample code for javax.imageio.stream.ImageInputStream.setBitOffset(int) definition code for javax.imageio.stream.ImageInputStream.setBitOffset(int) in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
Parameters:
bitOffset - the desired offset, as an int 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:
ImageInputStream.getBitOffset() sample code for javax.imageio.stream.ImageInputStream.getBitOffset() definition code for javax.imageio.stream.ImageInputStream.getBitOffset()

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

public int readBit()
            throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Description copied from interface: ImageInputStream 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. The bit offset is advanced by one and reduced modulo 8.

Specified by:
readBit sample code for javax.imageio.stream.ImageInputStream.readBit() definition code for javax.imageio.stream.ImageInputStream.readBit() in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
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.ImageInputStreamImpl.readBits(int) definition code for javax.imageio.stream.ImageInputStreamImpl.readBits(int)

public long readBits(int numBits)
              throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Description copied from interface: ImageInputStream sample code for javax.imageio.stream.ImageInputStream.readBits(int) definition code for javax.imageio.stream.ImageInputStream.readBits(int)
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.

Specified by:
readBits sample code for javax.imageio.stream.ImageInputStream.readBits(int) definition code for javax.imageio.stream.ImageInputStream.readBits(int) in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
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:
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.ImageInputStreamImpl.length() definition code for javax.imageio.stream.ImageInputStreamImpl.length()

public long length()
Returns -1L to indicate that the stream has unknown length. Subclasses must override this method to provide actual length information.

Specified by:
length sample code for javax.imageio.stream.ImageInputStream.length() definition code for javax.imageio.stream.ImageInputStream.length() in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
Returns:
-1L to indicate unknown length.

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

public int skipBytes(int n)
              throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Advances the current stream position by calling seek(getStreamPosition() + n).

The bit offset is reset to zero.

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
Specified by:
skipBytes sample code for javax.imageio.stream.ImageInputStream.skipBytes(int) definition code for javax.imageio.stream.ImageInputStream.skipBytes(int) in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
Parameters:
n - the number of bytes to seek forward.
Returns:
an int representing the number of bytes skipped.
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if getStreamPosition throws an IOException when computing either the starting or ending position.

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

public long skipBytes(long n)
               throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Advances the current stream position by calling seek(getStreamPosition() + n).

The bit offset is reset to zero.

Specified by:
skipBytes sample code for javax.imageio.stream.ImageInputStream.skipBytes(long) definition code for javax.imageio.stream.ImageInputStream.skipBytes(long) in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
Parameters:
n - the number of bytes to seek forward.
Returns:
a long representing the number of bytes skipped.
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if getStreamPosition throws an IOException when computing either the starting or ending position.

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

public void seek(long pos)
          throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Description copied from interface: ImageInputStream sample code for javax.imageio.stream.ImageInputStream.seek(long) definition code for javax.imageio.stream.ImageInputStream.seek(long)
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.

Specified by:
seek sample code for javax.imageio.stream.ImageInputStream.seek(long) definition code for javax.imageio.stream.ImageInputStream.seek(long) in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
Parameters:
pos - a long containing the desired file pointer position.
Throws:
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.ImageInputStreamImpl.mark() definition code for javax.imageio.stream.ImageInputStreamImpl.mark()

public void mark()
Pushes the current stream position onto a stack of marked positions.

Specified by:
mark sample code for javax.imageio.stream.ImageInputStream.mark() definition code for javax.imageio.stream.ImageInputStream.mark() in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream

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

public void reset()
           throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Resets the current stream byte and bit positions from the stack of marked positions.

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

Specified by:
reset sample code for javax.imageio.stream.ImageInputStream.reset() definition code for javax.imageio.stream.ImageInputStream.reset() in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
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.ImageInputStreamImpl.flushBefore(long) definition code for javax.imageio.stream.ImageInputStreamImpl.flushBefore(long)

public void flushBefore(long pos)
                 throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Description copied from interface: ImageInputStream sample code for javax.imageio.stream.ImageInputStream.flushBefore(long) definition code for javax.imageio.stream.ImageInputStream.flushBefore(long)
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.

Specified by:
flushBefore sample code for javax.imageio.stream.ImageInputStream.flushBefore(long) definition code for javax.imageio.stream.ImageInputStream.flushBefore(long) in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
Parameters:
pos - a long containing the length of the file prefix that may be flushed.
Throws:
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.ImageInputStreamImpl.flush() definition code for javax.imageio.stream.ImageInputStreamImpl.flush()

public void flush()
           throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Description copied from interface: ImageInputStream 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. Equivalent to flushBefore(getStreamPosition()).

Specified by:
flush sample code for javax.imageio.stream.ImageInputStream.flush() definition code for javax.imageio.stream.ImageInputStream.flush() in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
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.ImageInputStreamImpl.getFlushedPosition() definition code for javax.imageio.stream.ImageInputStreamImpl.getFlushedPosition()

public long getFlushedPosition()
Description copied from interface: ImageInputStream 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. The returned value will be the maximum of all values passed into previous calls to flushBefore.

Specified by:
getFlushedPosition sample code for javax.imageio.stream.ImageInputStream.getFlushedPosition() definition code for javax.imageio.stream.ImageInputStream.getFlushedPosition() in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
Returns:
the earliest legal position for seeking, as a long.

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

public boolean isCached()
Default implementation returns false. Subclasses should override this if they cache data.

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

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

public boolean isCachedMemory()
Default implementation returns false. Subclasses should override this if they cache data in main memory.

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

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

public boolean isCachedFile()
Default implementation returns false. Subclasses should override this if they cache data in a temporary file.

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

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

public void close()
           throws IOException sample code for java.io.IOException definition code for java.io.IOException 
Description copied from interface: ImageInputStream sample code for javax.imageio.stream.ImageInputStream.close() definition code for javax.imageio.stream.ImageInputStream.close()
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.

Specified by:
close sample code for javax.imageio.stream.ImageInputStream.close() definition code for javax.imageio.stream.ImageInputStream.close() in interface ImageInputStream sample code for javax.imageio.stream.ImageInputStream definition code for javax.imageio.stream.ImageInputStream
Throws:
IOException sample code for java.io.IOException definition code for java.io.IOException - if an I/O error occurs.

finalize sample code for javax.imageio.stream.ImageInputStreamImpl.finalize() definition code for javax.imageio.stream.ImageInputStreamImpl.finalize()

protected void finalize()
                 throws Throwable sample code for java.lang.Throwable definition code for java.lang.Throwable 
Finalizes this object prior to garbage collection. The close method is called to close any open input source. This method should not be called from application code.

Overrides:
finalize sample code for java.lang.Object.finalize() definition code for java.lang.Object.finalize() in class Object sample code for java.lang.Object definition code for java.lang.Object
Throws:
Throwable sample code for java.lang.Throwable definition code for java.lang.Throwable - if an error occurs during superclass finalization.