fop/fop-core/src/main/java/org/apache/fop/afp/AbstractAFPPainter.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/* $Id$ */

package org.apache.fop.afp;

import java.io.IOException;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 * A base AFP painter
 */
public abstract class AbstractAFPPainter {

    /** Static logging instance */
    protected static final Log log = LogFactory.getLog("org.apache.xmlgraphics.afp");

    /** data stream */
    protected final DataStream dataStream;
    /** painting state */
    protected final AFPPaintingState paintingState;

    /**
     * Main constructor
     *
     * @param paintingState the AFP painting state
     * @param dataStream the AFP Datastream
     */
    public AbstractAFPPainter(AFPPaintingState paintingState, DataStream dataStream) {
        this.paintingState = paintingState;
        this.dataStream = dataStream;
    }

    /**
     * Paints the painting item
     *
     * @param paintInfo the painting information
     * @throws IOException if an I/O error occurs
     */
    public abstract void paint(PaintingInfo paintInfo) throws IOException;
}