1 package org.apache.maven.doxia.sink;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "License"); you may not use this file except in compliance
10 * with the License. You may obtain a copy of the License at
11 *
12 * http://www.apache.org/licenses/LICENSE-2.0
13 *
14 * Unless required by applicable law or agreed to in writing,
15 * software distributed under the License is distributed on an
16 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 * KIND, either express or implied. See the License for the
18 * specific language governing permissions and limitations
19 * under the License.
20 */
21
22 import java.io.File;
23 import java.io.IOException;
24 import java.io.OutputStream;
25
26 /**
27 * A factory that creates a <code>Sink</code> object.
28 *
29 * @author <a href="kenney@apache.org">Kenney Westerhof</a>
30 * @version $Id: SinkFactory.java 736010 2009-01-20 13:06:57Z vsiveton $
31 * @since 1.0-alpha-9
32 */
33 public interface SinkFactory
34 {
35 /** The Plexus SinkFactory Role. */
36 String ROLE = SinkFactory.class.getName();
37
38 /**
39 * Create a <code>Sink</code> into a file.
40 *
41 * @param outputDir the not-null output dir.
42 * @param outputName the not-null output name.
43 * @return a <code>Sink</code> instance with a file as output.
44 * @throws java.io.IOException if any
45 */
46 Sink createSink( File outputDir, String outputName )
47 throws IOException;
48
49 /**
50 * Create a <code>Sink</code> into a file using a specified encoding.
51 *
52 * @param outputDir the not-null output dir.
53 * @param outputName the not-null output name.
54 * @param encoding the output encoding.
55 * @return a <code>Sink</code> instance with a file as output and using specified encoding.
56 * @throws java.io.IOException if any
57 * @see #createSink(File, String)
58 * @since 1.1
59 */
60 Sink createSink( File outputDir, String outputName, String encoding )
61 throws IOException;
62
63 /**
64 * Create a <code>Sink</code> into an OutputStream.
65 *
66 * @param out not null OutputStream to write the result.
67 * @return a <code>Sink</code> instance.
68 * @throws java.io.IOException if any
69 * @since 1.1
70 */
71 Sink createSink( OutputStream out )
72 throws IOException;
73
74 /**
75 * Create a <code>Sink</code> into an OutputStream using a specified encoding.
76 *
77 * @param out not null OutputStream to write the result.
78 * @param encoding the output encoding.
79 * @return a <code>Sink</code> instance using specified encoding.
80 * @throws java.io.IOException if any
81 * @since 1.1
82 */
83 Sink createSink( OutputStream out, String encoding )
84 throws IOException;
85 }