org.apache.maven.doxia.sink.SinkFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of doxia-sink-api Show documentation
Doxia Sink API.
The newest version!
/*
 * 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.
 */
package org.apache.maven.doxia.sink;

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

/**
 * A factory that creates a Sink object.
 *
 * @author Kenney Westerhof
 * @since 1.0-alpha-9
 */
public interface SinkFactory {

    /**
     * Create a Sink into a file.
     *
     * @param outputDir the not-null output dir.
     * @param outputName the not-null output name.
     * @return a Sink instance with a file as output.
     * @throws java.io.IOException if any.
     */
    Sink createSink(File outputDir, String outputName) throws IOException;

    /**
     * Create a Sink into a file using a specified encoding.
     *
     * @param outputDir the not-null output dir.
     * @param outputName the not-null output name.
     * @param encoding the output encoding.
     * @return a Sink instance with a file as output and using specified encoding.
     * @see #createSink(File, String)
     * @since 1.1
     * @throws java.io.IOException if any.
     */
    Sink createSink(File outputDir, String outputName, String encoding) throws IOException;

    /**
     * Create a Sink into an OutputStream.
     *
     * @param out not null OutputStream to write the result.
     * @return a Sink instance.
     * @since 1.1
     * @throws java.io.IOException if any.
     */
    Sink createSink(OutputStream out) throws IOException;

    /**
     * Create a Sink into an OutputStream using a specified encoding.
     *
     * @param out not null OutputStream to write the result.
     * @param encoding the output encoding.
     * @return a Sink instance using specified encoding.
     * @since 1.1
     * @throws java.io.IOException if any.
     */
    Sink createSink(OutputStream out, String encoding) throws IOException;
}