Closeable, DataInput, DataOutput, AutoCloseable, ImageInputStream, ImageOutputStream
public class FileImageOutputStream extends ImageOutputStreamImpl
ImageOutputStream that writes its output directly to a File or RandomAccessFile.bitOffset, byteOrder, flushedPos, streamPos
| Constructor | Description |
|---|---|
FileImageOutputStream |
Constructs a FileImageOutputStream that will write to a given File. |
FileImageOutputStream |
Constructs a FileImageOutputStream that will write to a given RandomAccessFile. |
| Modifier and Type | Method | Description |
|---|---|---|
void |
close() |
Closes the stream. |
protected void |
finalize() |
Deprecated, for removal: This API element is subject to removal in a future version. Finalization has been deprecated for removal. |
long |
length() |
Returns -1L to indicate that the stream has unknown length. |
int |
read() |
Reads a single byte from the stream and returns it as an int between 0 and 255. |
int |
read |
Reads up to len bytes from the stream, and stores them into b starting at index off. |
void |
seek |
Sets the current stream position and resets the bit offset to 0. |
void |
write |
Writes a sequence of bytes to the stream at the current position. |
void |
write |
Writes a single byte to the stream at the current position. |
flushBits, write, writeBit, writeBits, writeBoolean, writeByte, writeBytes, writeChar, writeChars, writeChars, writeDouble, writeDoubles, writeFloat, writeFloats, writeInt, writeInts, writeLong, writeLongs, writeShort, writeShorts, writeUTF
checkClosed, close, flush, flushBefore, getBitOffset, getByteOrder, getFlushedPosition, getStreamPosition, isCached, isCachedFile, isCachedMemory, length, mark, 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, setBitOffset, setByteOrder, skipBytes, skipBytes
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
flush, getBitOffset, getByteOrder, getFlushedPosition, getStreamPosition, isCached, isCachedFile, isCachedMemory, mark, 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, setBitOffset, setByteOrder, skipBytes, skipBytes
flushBefore
public FileImageOutputStream(File f) throws FileNotFoundException, IOException
FileImageOutputStream that will write to a given File.f - a File to write to.IllegalArgumentException - if f is null.SecurityException - if a security manager exists and does not allow write access to the file.FileNotFoundException - if f does not denote a regular file or it cannot be opened for reading and writing for any other reason.IOException - if an I/O error occurs.public FileImageOutputStream(RandomAccessFile raf)
FileImageOutputStream that will write to a given RandomAccessFile.raf - a RandomAccessFile to write to.IllegalArgumentException - if raf is null.public int read() throws IOException
ImageInputStreamImplint 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.
read in interface ImageInputStream
read in class ImageInputStreamImpl
-1 if EOF is reached.IOException - if the stream has been closed.public int read(byte[] b, int off, int len) throws IOException
ImageInputStreamImpllen 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.
read in interface ImageInputStream
read in class ImageInputStreamImpl
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.-1 to indicate EOF.IOException - if an I/O error occurs.public void write(int b) throws IOException
ImageOutputStreamb are ignored. If the bit offset within the stream is non-zero, the remainder of the current byte is padded with 0s and written out first. The bit offset will be 0 after the write. Implementers can use the flushBits method of ImageOutputStreamImpl to guarantee this.
b - an int whose lower 8 bits are to be written.IOException - if an I/O error occurs.public void write(byte[] b, int off, int len) throws IOException
ImageOutputStreamlen is 0, nothing is written. The byte b[off] is written first, then the byte b[off + 1], and so on. If the bit offset within the stream is non-zero, the remainder of the current byte is padded with 0s and written out first. The bit offset will be 0 after the write. Implementers can use the flushBits method of ImageOutputStreamImpl to guarantee this.
b - an array of bytes to be written.off - the start offset in the data.len - the number of bytes to write.IOException - if an I/O error occurs.public long length()
ImageInputStreamImpl-1L to indicate that the stream has unknown length. Subclasses must override this method to provide actual length information.length in interface ImageInputStream
length in class ImageInputStreamImpl
public void seek(long pos) throws IOException
EOFException will be thrown only if a read is performed. The file length will not be increased until a write is performed.pos - a long containing the desired file pointer position.IndexOutOfBoundsException - if pos is smaller than the flushed position.IOException - if any other I/O error occurs.public void close() throws IOException
ImageInputStreamIOExceptions 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.IOException - if an I/O error occurs.@Deprecated(since="9", forRemoval=true) protected void finalize() throws Throwable
Object.finalize() for background information and details about migration options.close method is called to close any open input source. This method should not be called from application code.finalize in class ImageInputStreamImpl
Throwable - if an error occurs during superclass finalization.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/imageio/stream/FileImageOutputStream.html