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