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 FileImageOutputStream

java.lang.Object extended by javax.imageio.stream.ImageInputStreamImpl extended by javax.imageio.stream.ImageOutputStreamImpl extended by javax.imageio.stream.FileImageOutputStream
All Implemented Interfaces:
ImageInputStream, ImageOutputStream

Most common way to construct:

File file = …;

FileImageOutputStream output = new FileImageOutputStream(file);

Based on 21 examples


public class FileImageOutputStream
extends ImageOutputStreamImpl

An implementation of ImageOutputStream that writes its output directly to a File or RandomAccessFile.


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

          Constructs a FileImageOutputStream that will write to a given File.

          Constructs a FileImageOutputStream that will write to a given RandomAccessFile.
 
Method Summary
 void

          
protected void

          Finalizes this object prior to garbage collection.
 long

          Returns -1L to indicate that the stream has unknown length.
 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)

          Sets the current stream position and resets the bit offset to 0.
 void
write(byte[] b, int off, int len)

          
 void
write(int b)

          
 
Methods inherited from class javax.imageio.stream.ImageOutputStreamImpl
flushBits, write, write, write, writeBit, writeBits, writeBoolean, writeByte, writeBytes, writeChar, writeChars, writeChars, writeDouble, writeDoubles, writeFloat, writeFloats, writeInt, writeInts, writeLong, writeLongs, writeShort, writeShorts, writeUTF
 
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

FileImageOutputStream

public FileImageOutputStream(File f)
                      throws FileNotFoundException,
                             IOException
Constructs a FileImageOutputStream that will write to a given File.

Parameters:
f - a File to write to.
Throws:
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.

FileImageOutputStream

public FileImageOutputStream(RandomAccessFile raf)
Constructs a FileImageOutputStream that will write to a given RandomAccessFile.

Parameters:
raf - a RandomAccessFile to write to.
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()
Overrides:
length in class ImageInputStreamImpl

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
Sets the current stream position and resets the bit offset to 0. It is legal to seeking past the end of the file; an EOFException will be thrown only if a read is performed. The file length will not be increased until a write is performed.

Overrides:
seek in class ImageInputStreamImpl
Parameters:
pos
Throws:
IOException - if any other I/O error occurs.

write

public void write(byte[] b,
                  int off,
                  int len)
           throws IOException
Overrides:
write in class ImageOutputStreamImpl
Parameters:
b
off
len
Throws:
IOException

write

public void write(int b)
           throws IOException
Overrides:
write in class ImageOutputStreamImpl
Parameters:
b
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/.