View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  package org.apache.maven.doxia.sink.impl;
20  
21  import java.io.Writer;
22  
23  import org.apache.maven.doxia.sink.Sink;
24  
25  /**
26   * An abstract <code>SinkFactory</code> for XML markup syntax. <code>UTF-8</code> is used
27   * when no encoding is specified.
28   *
29   * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
30   * @since 1.1
31   */
32  public abstract class AbstractXmlSinkFactory extends AbstractTextSinkFactory {
33      /**
34       * Create a text Sink for a given encoding and for a given language identifier.
35       *
36       * @param writer The writer for the sink output, never <code>null</code>.
37       * @param encoding The character encoding used by the writer.
38       * @param languageId language identifier for the root element as defined by
39       * <a href="ftp://ftp.isi.edu/in-notes/bcp/bcp47.txt">IETF BCP 47</a>, Tags for the Identification of Languages;
40       * in addition, the empty string may be specified.
41       * @return a Sink for XML output in the given encoding.
42       * @see <a href="http://www.w3.org/TR/REC-xml/#sec-lang-tag">http://www.w3.org/TR/REC-xml/#sec-lang-tag</a>
43       */
44      protected abstract Sink createSink(Writer writer, String encoding, String languageId);
45  }