Class ImageInputStreamImpl

protected int bitOffset

protected ByteOrder byteOrder

protected long flushedPos

protected long streamPos

public ImageInputStreamImpl()

The basic constructor. Object is special, because it has no superclass, so there is no call to super().

protected final void checkClosed()
            throws IOException

public void close()
            throws IOException

Specified by:

close in interface ImageInputStream

protected void finalize()
            throws Throwable

Called on an object by the Virtual Machine at most once, at some point after the Object is determined unreachable but before it is destroyed. You would think that this means it eventually is called on every Object, but this is not necessarily the case. If execution terminates abnormally, garbage collection does not always happen. Thus you cannot rely on this method to always work. For finer control over garbage collection, use references from the java.lang.ref package.

Virtual Machines are free to not call this method if they can determine that it does nothing important; for example, if your class extends Object and overrides finalize to do simply super.finalize().

finalize() will be called by a Thread that has no locks on any Objects, and may be called concurrently. There are no guarantees on the order in which multiple objects are finalized. This means that finalize() is usually unsuited for performing actions that must be thread-safe, and that your implementation must be use defensive programming if it is to always work.

If an Exception is thrown from finalize() during garbage collection, it will be patently ignored and the Object will still be destroyed.

It is allowed, although not typical, for user code to call finalize() directly. User invocation does not affect whether automatic invocation will occur. It is also permitted, although not recommended, for a finalize() method to "revive" an object by making it reachable from normal code again.

Unlike constructors, finalize() does not get called for an object's superclass unless the implementation specifically calls super.finalize().

The default implementation does nothing.

Overrides:

finalize in interface Object

Throws:

Throwable - permits a subclass to throw anything in an overridden version; but the default throws nothing

See Also:

System.gc(), System.runFinalizersOnExit(boolean), java.lang.ref

public void flush()
            throws IOException

Specified by:

flush in interface ImageInputStream

public void flushBefore(long position)
            throws IOException

Specified by:

flushBefore in interface ImageInputStream

public int getBitOffset()
            throws IOException

Specified by:

getBitOffset in interface ImageInputStream

public ByteOrder getByteOrder()

Specified by:

getByteOrder in interface ImageInputStream

public long getFlushedPosition()

Specified by:

getFlushedPosition in interface ImageInputStream

public long getStreamPosition()
            throws IOException

Specified by:

getStreamPosition in interface ImageInputStream

public boolean isCached()

Specified by:

isCached in interface ImageInputStream

public boolean isCachedFile()

Specified by:

isCachedFile in interface ImageInputStream

public boolean isCachedMemory()

Specified by:

isCachedMemory in interface ImageInputStream

public long length()

Specified by:

length in interface ImageInputStream

public void mark()

Specified by:

mark in interface ImageInputStream

public abstract int read()
            throws IOException

Specified by:

read in interface ImageInputStream

public int read(byte[] data)
            throws IOException

Specified by:

read in interface ImageInputStream

public abstract int read(byte[] data,
                         int offset,
                         int len)
            throws IOException

Specified by:

read in interface ImageInputStream

public int readBit()
            throws IOException

Specified by:

readBit in interface ImageInputStream

public long readBits(int numBits)
            throws IOException

Specified by:

readBits in interface ImageInputStream

public boolean readBoolean()
            throws IOException

Reads a byte and checks whether or not its value is zero.

The bit offset is set to zero before the byte is read.

Specified by:

readBoolean in interface ImageInputStream

readBoolean in interface DataInput

Throws:

IOException - if some general problem happens with accessing data.

See Also:

ImageInputStream.readBit(), ImageInputStream.readByte(), ImageInputStream.readFully(byte[],int,int)

public byte readByte()
            throws IOException

Reads a signed byte.

The bit offset is set to zero before any data is read.

Specified by:

readByte in interface ImageInputStream

readByte in interface DataInput

Throws:

IOException - if some general problem happens with accessing data.

See Also:

ImageInputStream.readUnsignedByte(), ImageInputStream.readFully(byte[],int,int)

public void readBytes(IIOByteBuffer buffer,
                      int len)
            throws IOException

Reads up to a specified number of bytes, and modifies a IIOByteBuffer to hold the read data.

The bit offset is set to zero before any data is read.

Specified by:

readBytes in interface ImageInputStream

Parameters:

Throws:

IndexOutOfBoundsException - if numBytes is negative.

NullPointerException - if buf is null.

IOException - if some general problem happens with accessing data.

public char readChar()
            throws IOException

Reads an unsigned 16-bit integer. If necessary, the value gets converted from the stream’s current byte order.

The bit offset is set to zero before any data is read.

This method does the same as ImageInputStream.readUnsignedShort().

Specified by:

readChar in interface ImageInputStream

readChar in interface DataInput

Throws:

IOException - if some general problem happens with accessing data.

See Also:

ImageInputStream.readFully(char[],int,int)

public double readDouble()
            throws IOException

Reads an IEEE 64-bit double-precision floating point number. If necessary, the value gets converted from the stream’s current byte order.

The bit offset is set to zero before any data is read.

Specified by:

readDouble in interface ImageInputStream

readDouble in interface DataInput

Throws:

IOException - if some general problem happens with accessing data.

See Also:

ImageInputStream.readFully(double[],int,int)

public float readFloat()
            throws IOException

Reads an IEEE 32-bit single-precision floating point number. If necessary, the value gets converted from the stream’s current byte order.

The bit offset is set to zero before any data is read.

Specified by:

readFloat in interface ImageInputStream

readFloat in interface DataInput

Throws:

IOException - if some general problem happens with accessing data.

See Also:

ImageInputStream.readFully(float[],int,int)

public void readFully(byte[] data)
            throws IOException

Reads a sequence of signed 8-bit integers into a byte[] array.

The bit offset is set to zero before any data is read.

Specified by:

readFully in interface ImageInputStream

readFully in interface DataInput

Parameters:

Throws:

NullPointerException - if b is null.

IOException - if some general problem happens with accessing data.

See Also:

ImageInputStream.readByte(), ImageInputStream.readFully(byte[],int,int)

public void readFully(byte[] data,
                      int offset,
                      int len)
            throws IOException

Reads a sequence of signed 8-bit integers into a byte[] array.

The bit offset is set to zero before any data is read.

Specified by:

readFully in interface ImageInputStream

readFully in interface DataInput

Parameters:

offset - the index of the first element in b that will hold read data.

Throws:

IndexOutOfBoundsException - if offset or numBytes is negative, or if offset + numBytes exceeds b.length.

NullPointerException - if b is null.

IOException - if some general problem happens with accessing data.

See Also:

ImageInputStream.readByte()

public void readFully(char[] data,
                      int offset,
                      int len)
            throws IOException

Reads a sequence of unsigned 16-bit integers into a char[] array. If necessary, values are converted from the stream’s current byte order.

The bit offset is set to zero before any data is read.

Specified by:

readFully in interface ImageInputStream

Parameters:

offset - the index of the first element in c that will hold read data.

Throws:

IndexOutOfBoundsException - if offset or numChars is negative, or if offset + numChars exceeds c.length.

NullPointerException - if c is null.

IOException - if some general problem happens with accessing data.

See Also:

ImageInputStream.readChar()

public void readFully(double[] data,
                      int offset,
                      int len)
            throws IOException

Reads a sequence of IEEE 64-bit double-precision floating point numbers into a double[] array. If necessary, values are converted from the stream’s current byte order.

The bit offset is set to zero before any data is read.

Specified by:

readFully in interface ImageInputStream

Parameters:

offset - the index of the first element in d that will hold read data.

Throws:

IndexOutOfBoundsException - if offset or numDoubles is negative, or if offset + numDoubles exceeds d.length.

NullPointerException - if d is null.

IOException - if some general problem happens with accessing data.

See Also:

ImageInputStream.readDouble()

public void readFully(float[] data,
                      int offset,
                      int len)
            throws IOException

Reads a sequence of IEEE 32-bit single-precision floating point numbers into a float[] array. If necessary, values are converted from the stream’s current byte order.

The bit offset is set to zero before any data is read.

Specified by:

readFully in interface ImageInputStream

Parameters:

offset - the index of the first element in d that will hold read data.

Throws:

IndexOutOfBoundsException - if offset or numFloats is negative, or if offset + numFloats exceeds f.length.

NullPointerException - if f is null.

IOException - if some general problem happens with accessing data.

See Also:

ImageInputStream.readFloat()

public void readFully(int[] data,
                      int offset,
                      int len)
            throws IOException

Reads a sequence of signed 32-bit integers into a long[] array. If necessary, values are converted from the stream’s current byte order.

The bit offset is set to zero before any data is read.

Specified by:

readFully in interface ImageInputStream

Parameters:

offset - the index of the first element in i that will hold read data.

Throws:

IndexOutOfBoundsException - if offset or numInts is negative, or if offset + numInts exceeds i.length.

NullPointerException - if i is null.

IOException - if some general problem happens with accessing data.

See Also:

ImageInputStream.readInt()

public void readFully(long[] data,
                      int offset,
                      int len)
            throws IOException

Reads a sequence of signed 64-bit integers into a long[] array. If necessary, values are converted from the stream’s current byte order.

The bit offset is set to zero before any data is read.

Specified by:

readFully in interface ImageInputStream

Parameters:

offset - the index of the first element in l that will hold read data.

Throws:

IndexOutOfBoundsException - if offset or numLongs is negative, or if offset + numLongs exceeds l.length.

NullPointerException - if l is null.

IOException - if some general problem happens with accessing data.

See Also:

ImageInputStream.readLong()

public void readFully(short[] data,
                      int offset,
                      int len)
            throws IOException

Reads a sequence of signed 16-bit integers into a short[] array. If necessary, values are converted from the stream’s current byte order.

The bit offset is set to zero before any data is read.

Specified by:

readFully in interface ImageInputStream

Parameters:

offset - the index of the first element in s that will hold read data.

Throws:

IndexOutOfBoundsException - if offset or numShorts is negative, or if offset + numShorts exceeds s.length.

NullPointerException - if s is null.

IOException - if some general problem happens with accessing data.

See Also:

ImageInputStream.readShort()

public int readInt()
            throws IOException

Reads a signed 32-bit integer. If necessary, the value gets converted from the stream’s current byte order.

The bit offset is set to zero before any data is read.

Specified by:

readInt in interface ImageInputStream

readInt in interface DataInput

Throws:

IOException - if some general problem happens with accessing data.

See Also:

ImageInputStream.readUnsignedInt(), ImageInputStream.readFully(int[],int,int)

public String readLine()
            throws IOException

This method reads the next line of text data from an input stream. It operates by reading bytes and converting those bytes to char values by treating the byte read as the low eight bits of the char and using 0 as the high eight bits. Because of this, it does not support the full 16-bit Unicode character set.

The reading of bytes ends when either the end of file or a line terminator is encountered. The bytes read are then returned as a String. A line terminator is a byte sequence consisting of either \r, \n or \r\n. These termination charaters are discarded and are not returned as part of the string. A line is also terminated by an end of file condition.

Specified by:

readLine in interface ImageInputStream

readLine in interface DataInput

Returns:

The line read as a String

Throws:

IOException - If an error occurs

public long readLong()
            throws IOException

Reads a signed 64-bit integer. If necessary, the value gets converted from the stream’s current byte order.

The bit offset is set to zero before any data is read.

Specified by:

readLong in interface ImageInputStream

readLong in interface DataInput

Throws:

IOException - if some general problem happens with accessing data.

See Also:

ImageInputStream.readFully(long[],int,int)

public short readShort()
            throws IOException

Reads an signed 16-bit integer. If necessary, the value gets converted from the stream’s current byte order.

The bit offset is set to zero before any data is read.

Specified by:

readShort in interface ImageInputStream

readShort in interface DataInput

Throws:

IOException - if some general problem happens with accessing data.

See Also:

ImageInputStream.readUnsignedShort(), ImageInputStream.readChar(), ImageInputStream.readFully(short[],int,int)

public String readUTF()
            throws IOException

This method reads a String from an input stream that is encoded in a modified UTF-8 format. This format has a leading two byte sequence that contains the remaining number of bytes to read. This two byte sequence is read using the readUnsignedShort() method of this interface. After the number of remaining bytes have been determined, these bytes are read an transformed into char values. These char values are encoded in the stream using either a one, two, or three byte format. The particular format in use can be determined by examining the first byte read.

If the first byte has a high order bit of 0, then that character consists on only one byte. This character value consists of seven bits that are at positions 0 through 6 of the byte. As an example, if byte1 is the byte read from the stream, it would be converted to a char like so:

(char)byte1

If the first byte has 110 as its high order bits, then the character consists of two bytes. The bits that make up the character value are in positions 0 through 4 of the first byte and bit positions 0 through 5 of the second byte. (The second byte should have 10 as its high order bits). These values are in most significant byte first (i.e., "big endian") order.

As an example, if byte1 and byte2 are the first two bytes read respectively, and the high order bits of them match the patterns which indicate a two byte character encoding, then they would be converted to a Java char like so:

(char)(((byte1 & 0x1F) << 6) + (byte2 & 0x3F))

If the first byte has a 1110 as its high order bits, then the character consists of three bytes. The bits that make up the character value are in positions 0 through 3 of the first byte and bit positions 0 through 5 of the other two bytes. (The second and third bytes should have 10 as their high order bits). These values are in most significant byte first (i.e., "big endian") order.

As an example, if byte1, byte2, and byte3 are the three bytes read, and the high order bits of them match the patterns which indicate a three byte character encoding, then they would be converted to a Java char like so: (char)(((byte1 & 0x0F) << 12) + ((byte2 & 0x3F) + (byte3 & 0x3F)) Note that all characters are encoded in the method that requires the fewest number of bytes with the exception of the character with the value of \<llll>u0000 which is encoded as two bytes. This is a modification of the UTF standard used to prevent C language style NUL values from appearing in the byte stream.

This method can read data that was written by an object implementing the writeUTF() method in DataOutput.

Specified by:

readUTF in interface ImageInputStream

readUTF in interface DataInput

Returns:

The String read

Throws:

IOException - If any other error occurs

See Also:

DataOutput.writeUTF(String)

public int readUnsignedByte()
            throws IOException

Reads an unsigned byte.

The bit offset is set to zero before any data is read.

Specified by:

readUnsignedByte in interface ImageInputStream

readUnsignedByte in interface DataInput

Throws:

IOException - if some general problem happens with accessing data.

See Also:

ImageInputStream.readByte(), ImageInputStream.readFully(byte[],int,int)

public long readUnsignedInt()
            throws IOException

Reads an unsigned 32-bit integer. If necessary, the value gets converted from the stream’s current byte order.

The bit offset is set to zero before any data is read.

Specified by:

readUnsignedInt in interface ImageInputStream

Throws:

IOException - if some general problem happens with accessing data.

See Also:

ImageInputStream.readInt(), ImageInputStream.readFully(int[],int,int)

public int readUnsignedShort()
            throws IOException

Reads an unsigned 16-bit integer. If necessary, the value gets converted from the stream’s current byte order.

The bit offset is set to zero before any data is read.

This method does the same as ImageInputStream.readChar().

Specified by:

readUnsignedShort in interface ImageInputStream

readUnsignedShort in interface DataInput

Throws:

IOException - if some general problem happens with accessing data.

See Also:

ImageInputStream.readShort(), ImageInputStream.readChar(), ImageInputStream.readFully(char[],int,int)

public void reset()
            throws IOException

Specified by:

reset in interface ImageInputStream

public void seek(long position)
            throws IOException

Specified by:

seek in interface ImageInputStream

public void setBitOffset(int bitOffset)
            throws IOException

Specified by:

setBitOffset in interface ImageInputStream

public void setByteOrder(ByteOrder byteOrder)

Specified by:

setByteOrder in interface ImageInputStream

public int skipBytes(int num)
            throws IOException

This method skips and discards the specified number of bytes in an input stream. Note that this method may skip less than the requested number of bytes. The actual number of bytes skipped is returned. No bytes are skipped if a negative number is passed to this method.

Specified by:

skipBytes in interface ImageInputStream

skipBytes in interface DataInput

Parameters:

Returns:

The number of bytes actually skipped, which will always be numBytes

Throws:

IOException - If any other error occurs

public long skipBytes(long num)
            throws IOException

Specified by:

skipBytes in interface ImageInputStream