1 ///////////////////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3 // Copyright (C) 2001-2024 the original author or authors.
4 //
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
9 //
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 ///////////////////////////////////////////////////////////////////////////////////////////////
19
20 package com.puppycrawl.tools.checkstyle.site;
21
22 import java.io.Writer;
23
24 import org.apache.maven.doxia.sink.Sink;
25 import org.apache.maven.doxia.sink.SinkFactory;
26 import org.apache.maven.doxia.sink.impl.AbstractTextSinkFactory;
27 import org.codehaus.plexus.component.annotations.Component;
28
29 /**
30 * Xdoc template implementation of the {@link SinkFactory}.
31 * This module will be removed once
32 * <a href="https://github.com/checkstyle/checkstyle/issues/13426">#13426</a> is resolved.
33 */
34 @Component(role = SinkFactory.class, hint = "xdocs-template")
35 public class XdocsTemplateSinkFactory extends AbstractTextSinkFactory {
36
37 /**
38 * Create a Sink instance.
39 *
40 * @param writer writer to use.
41 * @param encoding encoding of the writer.
42 * @return Sink instance.
43 */
44 @Override
45 public Sink createSink(Writer writer, String encoding) {
46 return new XdocsTemplateSink(writer, encoding);
47 }
48 }