Class XdocsTemplateSink
- java.lang.Object
-
- org.apache.maven.doxia.sink.impl.AbstractSink
-
- org.apache.maven.doxia.sink.impl.SinkAdapter
-
- org.apache.maven.doxia.sink.impl.AbstractXmlSink
-
- org.apache.maven.doxia.sink.impl.XhtmlBaseSink
-
- org.apache.maven.doxia.module.xdoc.XdocSink
-
- com.puppycrawl.tools.checkstyle.site.XdocsTemplateSink
-
- All Implemented Interfaces:
org.apache.maven.doxia.logging.LogEnabled
,org.apache.maven.doxia.markup.HtmlMarkup
,org.apache.maven.doxia.markup.Markup
,org.apache.maven.doxia.markup.XmlMarkup
,org.apache.maven.doxia.module.xdoc.XdocMarkup
,org.apache.maven.doxia.sink.Sink
public class XdocsTemplateSink extends org.apache.maven.doxia.module.xdoc.XdocSink
A sink for Checkstyle's xdoc templates. This module will be removed once #13426 is resolved.- See Also:
- Doxia Sink API
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
XdocsTemplateSink.CustomPrintWriter
A Custom writer that only prints Unix-style newline character.
-
Field Summary
Fields Modifier and Type Field Description private String
encoding
Encoding of the writer.-
Fields inherited from class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
inlineStack, tableAttributes, tableRows
-
Fields inherited from interface org.apache.maven.doxia.markup.HtmlMarkup
A, ABBR, ACRONYM, ADDRESS, APPLET, AREA, ARTICLE, ASIDE, AUDIO, B, BASE, BASEFONT, BDI, BDO, BIG, BLOCKQUOTE, BODY, BR, BUTTON, CANVAS, CAPTION, CDATA_TYPE, CENTER, CITE, CODE, COL, COLGROUP, COMMAND, DATA, DATALIST, DD, DEL, DETAILS, DFN, DIALOG, DIR, DIV, DL, DT, EM, EMBED, ENTITY_TYPE, FIELDSET, FIGCAPTION, FIGURE, FONT, FOOTER, FORM, FRAME, FRAMESET, H1, H2, H3, H4, H5, H6, HEAD, HEADER, HGROUP, HR, HTML, I, IFRAME, IMG, INPUT, INS, ISINDEX, KBD, KEYGEN, LABEL, LEGEND, LI, LINK, MAIN, MAP, MARK, MENU, META, METER, NAV, NOFRAMES, NOSCRIPT, OBJECT, OL, OPTGROUP, OPTION, OUTPUT, P, PARAM, PICTURE, PRE, PROGRESS, Q, RB, RP, RT, RTC, RUBY, S, SAMP, SCRIPT, SECTION, SELECT, SMALL, SOURCE, SPAN, STRIKE, STRONG, STYLE, SUB, SUMMARY, SUP, TABLE, TAG_TYPE_END, TAG_TYPE_SIMPLE, TAG_TYPE_START, TBODY, TD, TEMPLATE, TEXTAREA, TFOOT, TH, THEAD, TIME, TITLE, TR, TRACK, TT, U, UL, VAR, VIDEO, WBR
-
Fields inherited from interface org.apache.maven.doxia.markup.Markup
COLON, EOL, EQUAL, GREATER_THAN, LEFT_CURLY_BRACKET, LEFT_SQUARE_BRACKET, LESS_THAN, MINUS, PLUS, QUOTE, RIGHT_CURLY_BRACKET, RIGHT_SQUARE_BRACKET, SEMICOLON, SLASH, SPACE, STAR
-
Fields inherited from interface org.apache.maven.doxia.sink.Sink
JUSTIFY_CENTER, JUSTIFY_LEFT, JUSTIFY_RIGHT, NUMBERING_DECIMAL, NUMBERING_LOWER_ALPHA, NUMBERING_LOWER_ROMAN, NUMBERING_UPPER_ALPHA, NUMBERING_UPPER_ROMAN, ROLE, SECTION_LEVEL_1, SECTION_LEVEL_2, SECTION_LEVEL_3, SECTION_LEVEL_4, SECTION_LEVEL_5, SECTION_LEVEL_6
-
-
Constructor Summary
Constructors Constructor Description XdocsTemplateSink(Writer writer, String encoding)
Create a new instance, initialize the Writer.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
body()
Place the XML declaration at the top of the file.void
body_()
Place a newline at the end of the file, flush the writer, and reset the sink.void
link(String href)
Write an external link.void
tableRow()
Write a table row tag.void
tableRows(int[] justification, boolean grid)
Write a table tag.-
Methods inherited from class org.apache.maven.doxia.module.xdoc.XdocSink
author_, body, close, date_, head, head, head_, init, link, markup, onSection, onSection_, onSectionTitle, onSectionTitle_, title, title_, verbatim, verbatim_
-
Methods inherited from class org.apache.maven.doxia.sink.impl.XhtmlBaseSink
address, address, address_, anchor, anchor, anchor_, blockquote, blockquote, blockquote_, bold, bold_, comment, content, definedTerm, definedTerm, definedTerm_, definition, definition, definition_, definitionList, definitionList, definitionList_, division, division, division_, encodeURL, escapeHTML, figure, figure, figure_, figureCaption, figureCaption, figureCaption_, figureGraphics, figureGraphics, flush, getCellCount, getCellJustif, getTextBuffer, horizontalRule, horizontalRule, inline, inline, inline_, isHeadFlag, isVerbatimFlag, italic, italic_, lineBreak, lineBreak, link, link_, list, list, list_, listItem, listItem, listItem_, monospaced, monospaced_, nonBreakingSpace, numberedList, numberedList, numberedList_, numberedListItem, numberedListItem, numberedListItem_, pageBreak, paragraph, paragraph, paragraph_, rawText, resetState, resetTextBuffer, section, section_, section1, section1_, section2, section2_, section3, section3_, section4, section4_, section5, section5_, sectionTitle, sectionTitle_, sectionTitle1, sectionTitle1_, sectionTitle2, sectionTitle2_, sectionTitle3, sectionTitle3_, sectionTitle4, sectionTitle4_, sectionTitle5, sectionTitle5_, setCellCount, setCellJustif, setHeadFlag, setVerbatimFlag, table, table, table_, tableCaption, tableCaption, tableCaption_, tableCell, tableCell, tableCell, tableCell_, tableHeaderCell, tableHeaderCell, tableHeaderCell, tableHeaderCell_, tableRow, tableRow_, tableRows_, text, text, unknown, verbatim, verbatimContent, write, writeEndTag, writeStartTag
-
Methods inherited from class org.apache.maven.doxia.sink.impl.AbstractXmlSink
getNameSpace, setInsertNewline, setNameSpace, writeEOL, writeSimpleTag, writeSimpleTag, writeStartTag, writeStartTag
-
Methods inherited from class org.apache.maven.doxia.sink.impl.SinkAdapter
article, article, article_, author, author, content, content, content_, data, data, data_, date, date, definitionListItem, definitionListItem, definitionListItem_, footer, footer, footer_, header, header, header_, lineBreakOpportunity, lineBreakOpportunity, navigation, navigation, navigation_, section6, section6_, sectionTitle, sectionTitle_, sectionTitle6, sectionTitle6_, sidebar, sidebar, sidebar_, time, time, time_, title
-
-
-
-
Constructor Detail
-
XdocsTemplateSink
public XdocsTemplateSink(Writer writer, String encoding)
Create a new instance, initialize the Writer.- Parameters:
writer
- not null writer to write the result.encoding
- encoding of the writer.
-
-
Method Detail
-
body
public void body()
Place the XML declaration at the top of the file.- Specified by:
body
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
body
in classorg.apache.maven.doxia.module.xdoc.XdocSink
-
body_
public void body_()
Place a newline at the end of the file, flush the writer, and reset the sink.- Specified by:
body_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
body_
in classorg.apache.maven.doxia.module.xdoc.XdocSink
-
link
public void link(String href)
Write an external link. We override this method because the default implementation adds aclass="external-link"
attribute to the link which we don't want.- Specified by:
link
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
link
in classorg.apache.maven.doxia.sink.impl.XhtmlBaseSink
- Parameters:
href
- the link.
-
tableRow
public void tableRow()
Write a table row tag. We override this method because the default implementation adds aalign="top"
attribute to the row which we don't want.- Specified by:
tableRow
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableRow
in classorg.apache.maven.doxia.module.xdoc.XdocSink
-
tableRows
public void tableRows(int[] justification, boolean grid)
Write a table tag. We override this method because the default implementation adds different attributes which we don't want. We ignore the parameters because we don't need them, but the default implementation will take them into account once this class is removed.- Specified by:
tableRows
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
tableRows
in classorg.apache.maven.doxia.module.xdoc.XdocSink
- Parameters:
justification
- ignoredgrid
- ignored
-
-