001/////////////////////////////////////////////////////////////////////////////////////////////// 002// checkstyle: Checks Java source code and other text files for adherence to a set of rules. 003// Copyright (C) 2001-2024 the original author or authors. 004// 005// This library is free software; you can redistribute it and/or 006// modify it under the terms of the GNU Lesser General Public 007// License as published by the Free Software Foundation; either 008// version 2.1 of the License, or (at your option) any later version. 009// 010// This library is distributed in the hope that it will be useful, 011// but WITHOUT ANY WARRANTY; without even the implied warranty of 012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 013// Lesser General Public License for more details. 014// 015// You should have received a copy of the GNU Lesser General Public 016// License along with this library; if not, write to the Free Software 017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 018/////////////////////////////////////////////////////////////////////////////////////////////// 019 020package com.puppycrawl.tools.checkstyle.site; 021 022import java.io.Writer; 023 024import org.apache.maven.doxia.sink.Sink; 025import org.apache.maven.doxia.sink.SinkFactory; 026import org.apache.maven.doxia.sink.impl.AbstractTextSinkFactory; 027import org.codehaus.plexus.component.annotations.Component; 028 029/** 030 * Xdoc template implementation of the {@link SinkFactory}. 031 * This module will be removed once 032 * <a href="https://github.com/checkstyle/checkstyle/issues/13426">#13426</a> is resolved. 033 */ 034@Component(role = SinkFactory.class, hint = "xdocs-template") 035public class XdocsTemplateSinkFactory extends AbstractTextSinkFactory { 036 037 /** 038 * Create a Sink instance. 039 * 040 * @param writer writer to use. 041 * @param encoding encoding of the writer. 042 * @return Sink instance. 043 */ 044 @Override 045 public Sink createSink(Writer writer, String encoding) { 046 return new XdocsTemplateSink(writer, encoding); 047 } 048}