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 * @since 1.0-alpha-9
31 */
32 public interface SinkFactory
33 {
34 /** The Plexus SinkFactory Role. */
35 String ROLE = SinkFactory.class.getName();
36
37 /**
38 * Create a <code>Sink</code> into a file.
39 *
40 * @param outputDir the not-null output dir.
41 * @param outputName the not-null output name.
42 * @return a <code>Sink</code> instance with a file as output.
43 * @throws java.io.IOException if any.
44 */
45 Sink createSink( File outputDir, String outputName )
46 throws IOException;
47
48 /**
49 * Create a <code>Sink</code> into a file using a specified encoding.
50 *
51 * @param outputDir the not-null output dir.
52 * @param outputName the not-null output name.
53 * @param encoding the output encoding.
54 * @return a <code>Sink</code> instance with a file as output and using specified encoding.
55 * @see #createSink(File, String)
56 * @since 1.1
57 * @throws java.io.IOException if any.
58 */
59 Sink createSink( File outputDir, String outputName, String encoding )
60 throws IOException;
61
62 /**
63 * Create a <code>Sink</code> into an OutputStream.
64 *
65 * @param out not null OutputStream to write the result.
66 * @return a <code>Sink</code> instance.
67 * @since 1.1
68 * @throws java.io.IOException if any.
69 */
70 Sink createSink( OutputStream out )
71 throws IOException;
72
73 /**
74 * Create a <code>Sink</code> into an OutputStream using a specified encoding.
75 *
76 * @param out not null OutputStream to write the result.
77 * @param encoding the output encoding.
78 * @return a <code>Sink</code> instance using specified encoding.
79 * @since 1.1
80 * @throws java.io.IOException if any.
81 */
82 Sink createSink( OutputStream out, String encoding )
83 throws IOException;
84 }