/*

 * Copyright 2000-2007 Sun Microsystems, Inc.  All Rights Reserved.

 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

 *

 * This code is free software; you can redistribute it and/or modify it

 * under the terms of the GNU General Public License version 2 only, as

 * published by the Free Software Foundation.  Sun designates this

 * particular file as subject to the "Classpath" exception as provided

 * by Sun in the LICENSE file that accompanied this code.

 *

 * This code is distributed in the hope that it will be useful, but WITHOUT

 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

 * version 2 for more details (a copy is included in the LICENSE file that

 * accompanied this code).

 *

 * You should have received a copy of the GNU General Public License version

 * 2 along with this work; if not, write to the Free Software Foundation,

 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

 *

 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,

 * CA 95054 USA or visit www.sun.com if you need additional information or

 * have any questions.

 */

package javax.imageio.stream;

import java.io.File;

import java.io.FileNotFoundException;

import java.io.IOException;

import java.io.RandomAccessFile;

import com.sun.imageio.stream.CloseableDisposerRecord;

import com.sun.imageio.stream.StreamFinalizer;

import sun.java2d.Disposer;

/**

 * An implementation of <code>ImageOutputStream</code> that writes its

 * output directly to a <code>File</code> or

 * <code>RandomAccessFile</code>.

 *

 */

public class FileImageOutputStream extends ImageOutputStreamImpl {

    private RandomAccessFile raf;

    /** The referent to be registered with the Disposer. */

    private final Object disposerReferent;

    /** The DisposerRecord that closes the underlying RandomAccessFile. */

    private final CloseableDisposerRecord disposerRecord;

    /**

     * Constructs a <code>FileImageOutputStream</code> that will write

     * to a given <code>File</code>.

     *

     * @param f a <code>File</code> to write to.

     *

     * @exception IllegalArgumentException if <code>f</code> is

     * <code>null</code>.

     * @exception SecurityException if a security manager exists

     * and does not allow write access to the file.

     * @exception FileNotFoundException if <code>f</code> does not denote

     * a regular file or it cannot be opened for reading and writing for any

     * other reason.

     * @exception IOException if an I/O error occurs.

     */

    public FileImageOutputStream(File f)

        throws FileNotFoundException, IOException {

        this(f == null ? null : new RandomAccessFile(f, "rw"));

    }

    /**

     * Constructs a <code>FileImageOutputStream</code> that will write

     * to a given <code>RandomAccessFile</code>.

     *

     * @param raf a <code>RandomAccessFile</code> to write to.

     *

     * @exception IllegalArgumentException if <code>raf</code> is

     * <code>null</code>.

     */

    public FileImageOutputStream(RandomAccessFile raf) {

        if (raf == null) {

            throw new IllegalArgumentException("raf == null!");

        }

        this.raf = raf;

        disposerRecord = new CloseableDisposerRecord(raf);

        if (getClass() == FileImageOutputStream.class) {

            disposerReferent = new Object();

            Disposer.addRecord(disposerReferent, disposerRecord);

        } else {

            disposerReferent = new StreamFinalizer(this);

        }

    }

    public int read() throws IOException {

        checkClosed();

        bitOffset = 0;

        int val = raf.read();

        if (val != -1) {

            ++streamPos;

        }

        return val;

    }

    public int read(byte[] b, int off, int len) throws IOException {

        checkClosed();

        bitOffset = 0;

        int nbytes = raf.read(b, off, len);

        if (nbytes != -1) {

            streamPos += nbytes;

        }

        return nbytes;

    }

    public void write(int b) throws IOException {

        flushBits(); // this will call checkClosed() for us

        raf.write(b);

        ++streamPos;

    }

    public void write(byte[] b, int off, int len) throws IOException {

        flushBits(); // this will call checkClosed() for us

        raf.write(b, off, len);

        streamPos += len;

    }

    public long length() {

        try {

            checkClosed();

            return raf.length();

        } catch (IOException e) {

            return -1L;

        }

    }

    /**

     * Sets the current stream position and resets the bit offset to

     * 0.  It is legal to seeking past the end of the file; an

     * <code>EOFException</code> will be thrown only if a read is

     * performed.  The file length will not be increased until a write

     * is performed.

     *

     * @exception IndexOutOfBoundsException if <code>pos</code> is smaller

     * than the flushed position.

     * @exception IOException if any other I/O error occurs.

     */

    public void seek(long pos) throws IOException {

        checkClosed();

        if (pos < flushedPos) {

            throw new IndexOutOfBoundsException("pos < flushedPos!");

        }

        bitOffset = 0;

        raf.seek(pos);

        streamPos = raf.getFilePointer();

    }

    public void close() throws IOException {

        super.close();

        disposerRecord.dispose(); // this closes the RandomAccessFile

        raf = null;

    }

    /**

     * {@inheritDoc}

     */

    protected void finalize() throws Throwable {

        // Empty finalizer: for performance reasons we instead use the

        // Disposer mechanism for ensuring that the underlying

        // RandomAccessFile is closed prior to garbage collection

    }

}