/**
 * Copyright (c) 2003-2005, www.pdfbox.org
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 3. Neither the name of pdfbox; nor the names of its
 *    contributors may be used to endorse or promote products derived from this
 *    software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * http://www.pdfbox.org
 *
 */
package org.pdfbox.pdfwriter;

import java.io.IOException;
import java.io.OutputStream;

import org.pdfbox.persistence.util.COSObjectKey;

import org.pdfbox.cos.COSBase;
import org.pdfbox.cos.COSFloat;
import org.pdfbox.cos.COSName;
import org.pdfbox.cos.COSString;
import org.pdfbox.cos.COSBoolean;
import org.pdfbox.cos.COSArray;
import org.pdfbox.cos.COSDocument;
import org.pdfbox.cos.COSStream;
import org.pdfbox.cos.COSObject;
import org.pdfbox.cos.COSDictionary;
import org.pdfbox.cos.COSInteger;
import org.pdfbox.cos.COSNull;

public abstract class COSWriterAbstract {
    // the stream where we create the pdf output
    private OutputStream output;

    /**
     * This will get the output stream.
     *
     * @return The output stream.
     */
    protected java.io.OutputStream getOutput()
    {
        return output;
    }

    /**
     * This will set the output stream.
     *
     * @param newOutput The new output stream.
     */
    private void setOutput( OutputStream newOutput )
    {
        output = newOutput;
    }

    public COSWriterAbstract(OutputStream os) {
        setOutput(os);
    }

    public void close() throws IOException {
        if (getOutput() != null)
        {
            getOutput().close();
        }
    }

    public abstract long getCurrentXRefPos();
    public abstract void objectStart( COSBase obj, COSObjectKey currentObjectKey ) throws IOException;
    public abstract void objectEnd( COSBase obj) throws IOException;
    public abstract void objectWrite(COSString obj) throws IOException;
    public abstract void objectWrite(COSBoolean obj) throws IOException;
    public abstract void objectWrite(COSFloat obj) throws IOException;
    public abstract void objectWrite(COSInteger obj) throws IOException;
    public abstract void objectWrite(COSName obj) throws IOException;
    public abstract void objectWrite(COSNull obj) throws IOException;
    public abstract void documentStart(COSDocument doc) throws IOException;
    public abstract void documentEnd() throws IOException;
    public abstract void bodyStart() throws IOException;
    public abstract void bodyEnd() throws IOException;
    public abstract void writeHeader(COSDocument doc) throws IOException;
    public abstract void trailerStart() throws IOException ;
    public abstract void trailerEnd(long startXref) throws IOException;
    public abstract void xrefStart(long lastKeyNumber) throws IOException;
    public abstract void xrefEntryFree() throws IOException;
    public abstract void xrefEntry(COSWriterXRefEntry entry) throws IOException;
    public abstract void xrefEnd() throws IOException;
    public abstract void arrayStart(COSArray obj) throws IOException;
    public abstract void arrayElementStart(int count) throws IOException;
    public abstract void arrayElementEnd(boolean hasNext, int count) throws IOException;
    public abstract void arrayEnd() throws IOException;
    public abstract void dictStart() throws IOException;
    public abstract void dictName(COSName obj) throws IOException;
    public abstract void dictPairEnd() throws IOException;
    public abstract void dictEnd() throws IOException;
    public abstract void writeRefKey(COSObjectKey key) throws IOException;
    public abstract void streamStart() throws IOException;
    public abstract void streamBlock(byte[] buffer, int amountRead) throws IOException;
    public abstract void streamEnd() throws IOException;

}