| Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
| AbstractXmlSinkFactory |
|
| 1.0;1 |
| 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.Writer; | |
| 23 | ||
| 24 | /** | |
| 25 | * An abstract <code>SinkFactory</code> for XML markup syntax. <code>UTF-8</code> is used | |
| 26 | * when no encoding is specified. | |
| 27 | * | |
| 28 | * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a> | |
| 29 | * @version $Id: AbstractXmlSinkFactory.java 746978 2009-02-23 12:20:33Z vsiveton $ | |
| 30 | * @since 1.1 | |
| 31 | */ | |
| 32 | 4 | public abstract class AbstractXmlSinkFactory |
| 33 | extends AbstractTextSinkFactory | |
| 34 | { | |
| 35 | /** | |
| 36 | * Create a text Sink for a given encoding and for a given language identifier. | |
| 37 | * | |
| 38 | * @param writer The writer for the sink output, never <code>null</code>. | |
| 39 | * @param encoding The character encoding used by the writer. | |
| 40 | * @param languageId language identifier for the root element as defined by | |
| 41 | * <a href="ftp://ftp.isi.edu/in-notes/bcp/bcp47.txt">IETF BCP 47</a>, Tags for the Identification of Languages; | |
| 42 | * in addition, the empty string may be specified. | |
| 43 | * @return a Sink for XML output in the given encoding. | |
| 44 | * @see <a href="http://www.w3.org/TR/REC-xml/#sec-lang-tag">http://www.w3.org/TR/REC-xml/#sec-lang-tag</a> | |
| 45 | */ | |
| 46 | protected abstract Sink createSink( Writer writer, String encoding, String languageId ); | |
| 47 | } |