fop/fop-core/src/main/java/org/apache/fop/afp/Streamable.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 java.io.OutputStream;

/**
 * Implementing object is able to write to an OutputStream
 */
public interface Streamable {

    /**
     * DataStream objects must implement the writeToStream()
     * method to write its data to the given OutputStream
     *
     * @param os the outputsteam stream
     * @throws java.io.IOException an I/O exception of some sort has occurred.
     */
    void writeToStream(OutputStream os) throws IOException;
}