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