FileImageInputStream (Java Platform SE 7 ) (original) (raw)

java.lang.Object
- javax.imageio.stream.ImageInputStreamImpl
- - javax.imageio.stream.FileImageInputStream
All Implemented Interfaces:
Closeable, DataInput, AutoCloseable, ImageInputStream

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](../../../javax/imageio/stream/ImageInputStreamImpl.html "class in javax.imageio.stream")  
 `[bitOffset](../../../javax/imageio/stream/ImageInputStreamImpl.html#bitOffset), [byteOrder](../../../javax/imageio/stream/ImageInputStreamImpl.html#byteOrder), [flushedPos](../../../javax/imageio/stream/ImageInputStreamImpl.html#flushedPos), [streamPos](../../../javax/imageio/stream/ImageInputStreamImpl.html#streamPos)`

Constructor Summary

Constructors

Constructor and Description
FileImageInputStream(File f) Constructs a FileImageInputStream that will read from a given File.
FileImageInputStream(RandomAccessFile raf) Constructs a FileImageInputStream that will read from a given RandomAccessFile.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the stream.
protected void	finalize() Finalizes this object prior to garbage collection.
long	length() Returns the length of the underlying file, or -1 if it is unknown.
int	read() Reads a single byte from the stream and returns it as anint between 0 and 255.
int	read(byte[] b, int off, int len) Reads up to len bytes from the stream, and stores them into b starting at index off.
void	seek(long pos) Sets the current stream position to the desired location.

   * ### Methods inherited from class javax.imageio.stream.[ImageInputStreamImpl](../../../javax/imageio/stream/ImageInputStreamImpl.html "class in javax.imageio.stream")  
   `[checkClosed](../../../javax/imageio/stream/ImageInputStreamImpl.html#checkClosed%28%29), [flush](../../../javax/imageio/stream/ImageInputStreamImpl.html#flush%28%29), [flushBefore](../../../javax/imageio/stream/ImageInputStreamImpl.html#flushBefore%28long%29), [getBitOffset](../../../javax/imageio/stream/ImageInputStreamImpl.html#getBitOffset%28%29), [getByteOrder](../../../javax/imageio/stream/ImageInputStreamImpl.html#getByteOrder%28%29), [getFlushedPosition](../../../javax/imageio/stream/ImageInputStreamImpl.html#getFlushedPosition%28%29), [getStreamPosition](../../../javax/imageio/stream/ImageInputStreamImpl.html#getStreamPosition%28%29), [isCached](../../../javax/imageio/stream/ImageInputStreamImpl.html#isCached%28%29), [isCachedFile](../../../javax/imageio/stream/ImageInputStreamImpl.html#isCachedFile%28%29), [isCachedMemory](../../../javax/imageio/stream/ImageInputStreamImpl.html#isCachedMemory%28%29), [mark](../../../javax/imageio/stream/ImageInputStreamImpl.html#mark%28%29), [read](../../../javax/imageio/stream/ImageInputStreamImpl.html#read%28byte[]%29), [readBit](../../../javax/imageio/stream/ImageInputStreamImpl.html#readBit%28%29), [readBits](../../../javax/imageio/stream/ImageInputStreamImpl.html#readBits%28int%29), [readBoolean](../../../javax/imageio/stream/ImageInputStreamImpl.html#readBoolean%28%29), [readByte](../../../javax/imageio/stream/ImageInputStreamImpl.html#readByte%28%29), [readBytes](../../../javax/imageio/stream/ImageInputStreamImpl.html#readBytes%28javax.imageio.stream.IIOByteBuffer,%20int%29), [readChar](../../../javax/imageio/stream/ImageInputStreamImpl.html#readChar%28%29), [readDouble](../../../javax/imageio/stream/ImageInputStreamImpl.html#readDouble%28%29), [readFloat](../../../javax/imageio/stream/ImageInputStreamImpl.html#readFloat%28%29), [readFully](../../../javax/imageio/stream/ImageInputStreamImpl.html#readFully%28byte[]%29), [readFully](../../../javax/imageio/stream/ImageInputStreamImpl.html#readFully%28byte[],%20int,%20int%29), [readFully](../../../javax/imageio/stream/ImageInputStreamImpl.html#readFully%28char[],%20int,%20int%29), [readFully](../../../javax/imageio/stream/ImageInputStreamImpl.html#readFully%28double[],%20int,%20int%29), [readFully](../../../javax/imageio/stream/ImageInputStreamImpl.html#readFully%28float[],%20int,%20int%29), [readFully](../../../javax/imageio/stream/ImageInputStreamImpl.html#readFully%28int[],%20int,%20int%29), [readFully](../../../javax/imageio/stream/ImageInputStreamImpl.html#readFully%28long[],%20int,%20int%29), [readFully](../../../javax/imageio/stream/ImageInputStreamImpl.html#readFully%28short[],%20int,%20int%29), [readInt](../../../javax/imageio/stream/ImageInputStreamImpl.html#readInt%28%29), [readLine](../../../javax/imageio/stream/ImageInputStreamImpl.html#readLine%28%29), [readLong](../../../javax/imageio/stream/ImageInputStreamImpl.html#readLong%28%29), [readShort](../../../javax/imageio/stream/ImageInputStreamImpl.html#readShort%28%29), [readUnsignedByte](../../../javax/imageio/stream/ImageInputStreamImpl.html#readUnsignedByte%28%29), [readUnsignedInt](../../../javax/imageio/stream/ImageInputStreamImpl.html#readUnsignedInt%28%29), [readUnsignedShort](../../../javax/imageio/stream/ImageInputStreamImpl.html#readUnsignedShort%28%29), [readUTF](../../../javax/imageio/stream/ImageInputStreamImpl.html#readUTF%28%29), [reset](../../../javax/imageio/stream/ImageInputStreamImpl.html#reset%28%29), [setBitOffset](../../../javax/imageio/stream/ImageInputStreamImpl.html#setBitOffset%28int%29), [setByteOrder](../../../javax/imageio/stream/ImageInputStreamImpl.html#setByteOrder%28java.nio.ByteOrder%29), [skipBytes](../../../javax/imageio/stream/ImageInputStreamImpl.html#skipBytes%28int%29), [skipBytes](../../../javax/imageio/stream/ImageInputStreamImpl.html#skipBytes%28long%29)`  
   * ### Methods inherited from class java.lang.[Object](../../../java/lang/Object.html "class in java.lang")  
   `[clone](../../../java/lang/Object.html#clone%28%29), [equals](../../../java/lang/Object.html#equals%28java.lang.Object%29), [getClass](../../../java/lang/Object.html#getClass%28%29), [hashCode](../../../java/lang/Object.html#hashCode%28%29), [notify](../../../java/lang/Object.html#notify%28%29), [notifyAll](../../../java/lang/Object.html#notifyAll%28%29), [toString](../../../java/lang/Object.html#toString%28%29), [wait](../../../java/lang/Object.html#wait%28%29), [wait](../../../java/lang/Object.html#wait%28long%29), [wait](../../../java/lang/Object.html#wait%28long,%20int%29)`

Constructor Detail

 * #### FileImageInputStream  
 public FileImageInputStream([File](../../../java/io/File.html "class in java.io") f)  
                      throws [FileNotFoundException](../../../java/io/FileNotFoundException.html "class in java.io"),  
                             [IOException](../../../java/io/IOException.html "class in java.io")  
 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:  
 `[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if `f` is`null`.  
 `[SecurityException](../../../java/lang/SecurityException.html "class in java.lang")` \- if a security manager exists and does not allow read access to the file.  
 `[FileNotFoundException](../../../java/io/FileNotFoundException.html "class in java.io")` \- if `f` is a directory or cannot be opened for reading for any other reason.  
 `[IOException](../../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs.  
 * #### FileImageInputStream  
 public FileImageInputStream([RandomAccessFile](../../../java/io/RandomAccessFile.html "class in java.io") 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.  
 Throws:  
 `[IllegalArgumentException](../../../java/lang/IllegalArgumentException.html "class in java.lang")` \- if `raf` is`null`.

Method Detail

* #### read  
public int read()  
         throws [IOException](../../../java/io/IOException.html "class in java.io")  
Reads a single byte from the stream and returns it as an`int` between 0 and 255\. If EOF is reached,`-1` is returned.  
 Subclasses must provide an implementation for this method. The subclass implementation should update the stream position before exiting.  
 The bit offset within the stream must be reset to zero before the read occurs.  
**Specified by:**  
`[read](../../../javax/imageio/stream/ImageInputStream.html#read%28%29)` in interface `[ImageInputStream](../../../javax/imageio/stream/ImageInputStream.html "interface in javax.imageio.stream")`  
**Specified by:**  
`[read](../../../javax/imageio/stream/ImageInputStreamImpl.html#read%28%29)` in class `[ImageInputStreamImpl](../../../javax/imageio/stream/ImageInputStreamImpl.html "class in javax.imageio.stream")`  
Returns:  
the value of the next byte in the stream, or `-1` if EOF is reached.  
Throws:  
`[IOException](../../../java/io/IOException.html "class in java.io")` \- if the stream has been closed.  
* #### read  
public int read(byte[] b,  
       int off,  
       int len)  
         throws [IOException](../../../java/io/IOException.html "class in java.io")  
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](../../../javax/imageio/stream/ImageInputStream.html#read%28byte[],%20int,%20int%29)` in interface `[ImageInputStream](../../../javax/imageio/stream/ImageInputStream.html "interface in javax.imageio.stream")`  
**Specified by:**  
`[read](../../../javax/imageio/stream/ImageInputStreamImpl.html#read%28byte[],%20int,%20int%29)` in class `[ImageInputStreamImpl](../../../javax/imageio/stream/ImageInputStreamImpl.html "class in javax.imageio.stream")`  
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:  
`[IOException](../../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs.  
* #### length  
public long length()  
Returns the length of the underlying file, or `-1` if it is unknown.  
**Specified by:**  
`[length](../../../javax/imageio/stream/ImageInputStream.html#length%28%29)` in interface `[ImageInputStream](../../../javax/imageio/stream/ImageInputStream.html "interface in javax.imageio.stream")`  
**Overrides:**  
`[length](../../../javax/imageio/stream/ImageInputStreamImpl.html#length%28%29)` in class `[ImageInputStreamImpl](../../../javax/imageio/stream/ImageInputStreamImpl.html "class in javax.imageio.stream")`  
Returns:  
the file length as a `long`, or`-1`.  
* #### seek  
public void seek(long pos)  
          throws [IOException](../../../java/io/IOException.html "class in java.io")  
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](../../../javax/imageio/stream/ImageInputStream.html#seek%28long%29)` in interface `[ImageInputStream](../../../javax/imageio/stream/ImageInputStream.html "interface in javax.imageio.stream")`  
**Overrides:**  
`[seek](../../../javax/imageio/stream/ImageInputStreamImpl.html#seek%28long%29)` in class `[ImageInputStreamImpl](../../../javax/imageio/stream/ImageInputStreamImpl.html "class in javax.imageio.stream")`  
Parameters:  
`pos` \- a `long` containing the desired file pointer position.  
Throws:  
`[IOException](../../../java/io/IOException.html "class in java.io")` \- if any other I/O error occurs.  
* #### close  
public void close()  
           throws [IOException](../../../java/io/IOException.html "class in java.io")  
Closes the stream. Attempts to access a stream that has been closed may result in `IOException`s 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](../../../java/io/Closeable.html#close%28%29)` in interface `[Closeable](../../../java/io/Closeable.html "interface in java.io")`  
**Specified by:**  
`[close](../../../java/lang/AutoCloseable.html#close%28%29)` in interface `[AutoCloseable](../../../java/lang/AutoCloseable.html "interface in java.lang")`  
**Specified by:**  
`[close](../../../javax/imageio/stream/ImageInputStream.html#close%28%29)` in interface `[ImageInputStream](../../../javax/imageio/stream/ImageInputStream.html "interface in javax.imageio.stream")`  
**Overrides:**  
`[close](../../../javax/imageio/stream/ImageInputStreamImpl.html#close%28%29)` in class `[ImageInputStreamImpl](../../../javax/imageio/stream/ImageInputStreamImpl.html "class in javax.imageio.stream")`  
Throws:  
`[IOException](../../../java/io/IOException.html "class in java.io")` \- if an I/O error occurs.  
* #### finalize  
protected void finalize()  
                 throws [Throwable](../../../java/lang/Throwable.html "class in java.lang")  
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](../../../javax/imageio/stream/ImageInputStreamImpl.html#finalize%28%29)` in class `[ImageInputStreamImpl](../../../javax/imageio/stream/ImageInputStreamImpl.html "class in javax.imageio.stream")`  
Throws:  
`[Throwable](../../../java/lang/Throwable.html "class in java.lang")` \- if an error occurs during superclass finalization.

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2020, Oracle and/or its affiliates. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.

FileImageInputStream (Java Platform SE 7 ) (original) (raw)

Field Summary

Constructor Summary

Method Summary

Constructor Detail

Method Detail