001/* 002 * Licensed to the Apache Software Foundation (ASF) under one 003 * or more contributor license agreements. See the NOTICE file 004 * distributed with this work for additional information 005 * regarding copyright ownership. The ASF licenses this file 006 * to you under the Apache License, Version 2.0 (the 007 * "License"); you may not use this file except in compliance 008 * with the License. You may obtain a copy of the License at 009 * 010 * http://www.apache.org/licenses/LICENSE-2.0 011 * 012 * Unless required by applicable law or agreed to in writing, 013 * software distributed under the License is distributed on an 014 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 015 * KIND, either express or implied. See the License for the 016 * specific language governing permissions and limitations 017 * under the License. 018 */ 019package org.apache.maven.doxia.sink.impl; 020 021import java.io.Writer; 022 023import org.apache.maven.doxia.sink.Sink; 024 025/** 026 * An abstract <code>SinkFactory</code> for XML markup syntax. <code>UTF-8</code> is used 027 * when no encoding is specified. 028 * 029 * @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a> 030 * @since 1.1 031 */ 032public abstract class AbstractXmlSinkFactory extends AbstractTextSinkFactory { 033 /** 034 * Create a text Sink for a given encoding and for a given language identifier. 035 * 036 * @param writer The writer for the sink output, never <code>null</code>. 037 * @param encoding The character encoding used by the writer. 038 * @param languageId language identifier for the root element as defined by 039 * <a href="ftp://ftp.isi.edu/in-notes/bcp/bcp47.txt">IETF BCP 47</a>, Tags for the Identification of Languages; 040 * in addition, the empty string may be specified. 041 * @return a Sink for XML output in the given encoding. 042 * @see <a href="http://www.w3.org/TR/REC-xml/#sec-lang-tag">http://www.w3.org/TR/REC-xml/#sec-lang-tag</a> 043 */ 044 protected abstract Sink createSink(Writer writer, String encoding, String languageId); 045}