This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


javax.imageio.stream
class FileImageInputStream

java.lang.Object extended by javax.imageio.stream.ImageInputStreamImpl extended by javax.imageio.stream.FileImageInputStream
All Implemented Interfaces:
ImageInputStream

Most common way to construct:

File sourceFile = …;

FileImageInputStream imageInputStream = new FileImageInputStream(sourceFile);

Based on 7 examples


public class FileImageInputStream
extends ImageInputStreamImpl

An implementation of ImageInputStream that gets its input from a File or RandomAccessFile. The file contents are assumed to be stable during the lifetime of the object.


Field Summary
 
Fields inherited from class javax.imageio.stream.ImageInputStreamImpl
bitOffset, byteOrder, flushedPos, streamPos
 
Constructor Summary

          Constructs a FileImageInputStream that will read from a given File.

          Constructs a FileImageInputStream that will read from a given RandomAccessFile.
 
Method Summary
 void

          
protected void

          Finalizes this object prior to garbage collection.
 long

          Returns the length of the underlying file, or -1 if it is unknown.
 int

          Reads a single byte from the stream and returns it as an int between 0 and 255.
 int
read(byte[] b, int off, int len)

          Reads a single byte from the stream and returns it as an int between 0 and 255.
 void
seek(long pos)

          
 
Methods inherited from class javax.imageio.stream.ImageInputStreamImpl
checkClosed, close, finalize, flush, flushBefore, getBitOffset, getByteOrder, getFlushedPosition, getStreamPosition, isCached, isCachedFile, isCachedMemory, length, mark, read, read, read, readBit, readBits, readBoolean, readByte, readBytes, readChar, readDouble, readFloat, readFully, readFully, readFully, readFully, readFully, readFully, readFully, readFully, readInt, readLine, readLong, readShort, readUnsignedByte, readUnsignedInt, readUnsignedShort, readUTF, reset, seek, setBitOffset, setByteOrder, skipBytes, skipBytes
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FileImageInputStream

public FileImageInputStream(File f)
                     throws FileNotFoundException,
                            IOException
Constructs a FileImageInputStream that will read from a given File.

The file contents must not change between the time this object is constructed and the time of the last call to a read method.

Parameters:
f - a File to read from.
Throws:
FileNotFoundException - if f is a directory or cannot be opened for reading for any other reason.
IOException - if an I/O error occurs.

FileImageInputStream

public FileImageInputStream(RandomAccessFile raf)
Constructs a FileImageInputStream that will read from a given RandomAccessFile.

The file contents must not change between the time this object is constructed and the time of the last call to a read method.

Parameters:
raf - a RandomAccessFile to read from.
Method Detail

close

public void close()
           throws IOException
Overrides:
close in class ImageInputStreamImpl
Throws:
IOException

finalize

protected void finalize()
                 throws Throwable
{@inheritDoc}

Overrides:
finalize in class ImageInputStreamImpl
Throws:
Throwable

length

public long length()
Returns the length of the underlying file, or -1 if it is unknown.

Overrides:
length in class ImageInputStreamImpl
Returns:
the file length as a long, or -1.

read

public int read()
         throws IOException
Overrides:
read in class ImageInputStreamImpl
Throws:
IOException

read

public int read(byte[] b,
                int off,
                int len)
         throws IOException
Overrides:
read in class ImageInputStreamImpl
Parameters:
b
off
len
Throws:
IOException

seek

public void seek(long pos)
          throws IOException
Overrides:
seek in class ImageInputStreamImpl
Parameters:
pos
Throws:
IOException


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.