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 import java.io.OutputStreamWriter;
26 import java.io.Writer;
27
28 import org.codehaus.plexus.util.WriterFactory;
29
30 /**
31 * An abstract <code>SinkFactory</code> for Text markup syntax. <code>UTF-8</code> is used
32 * when no encoding is specified.
33 *
34 * @author Hervé Boutemy
35 * @author Benjamin Bentmann
36 * @version $Id: AbstractTextSinkFactory.java 746978 2009-02-23 12:20:33Z vsiveton $
37 * @since 1.1
38 */
39 public abstract class AbstractTextSinkFactory
40 implements SinkFactory
41 {
42 /**
43 * Create a text Sink for a given encoding.
44 *
45 * @param writer The writer for the sink output, never <code>null</code>.
46 * @param encoding The character encoding used by the writer.
47 * @return a Sink for text output in the given encoding.
48 */
49 protected abstract Sink createSink( Writer writer, String encoding );
50
51 /** {@inheritDoc} */
52 public Sink createSink( File outputDir, String outputName )
53 throws IOException
54 {
55 return createSink( outputDir, outputName, WriterFactory.UTF_8 );
56 }
57
58 /** {@inheritDoc} */
59 public Sink createSink( File outputDir, String outputName, String encoding )
60 throws IOException
61 {
62 if ( outputDir == null )
63 {
64 throw new IllegalArgumentException( "outputDir cannot be null." );
65 }
66
67 if ( !outputDir.exists() )
68 {
69 outputDir.mkdirs();
70 }
71 else
72 {
73 if ( !outputDir.isDirectory() )
74 {
75 throw new IllegalArgumentException( "The dir '" + outputDir + "' is not a directory." );
76 }
77 }
78
79 Writer writer = WriterFactory.newWriter( new File( outputDir, outputName ), encoding );
80
81 return createSink( writer, encoding );
82 }
83
84 /** {@inheritDoc} */
85 public Sink createSink( OutputStream out )
86 throws IOException
87 {
88 return createSink( out, WriterFactory.UTF_8 );
89 }
90
91 /** {@inheritDoc} */
92 public Sink createSink( OutputStream out, String encoding )
93 throws IOException
94 {
95 return createSink( new OutputStreamWriter( out, encoding ), encoding );
96 }
97 }