Class SiteRendererSink
- 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.Xhtml5BaseSink
-
- org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
-
- org.apache.maven.doxia.siterenderer.sink.SiteRendererSink
-
- 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.xhtml5.Xhtml5Markup
,org.apache.maven.doxia.sink.Sink
,DocumentContent
,org.codehaus.doxia.sink.Sink
public class SiteRendererSink extends org.apache.maven.doxia.module.xhtml5.Xhtml5Sink implements org.apache.maven.doxia.sink.Sink, org.codehaus.doxia.sink.Sink, DocumentContent
Sink for site rendering of a document, to allow later merge document's output with a template. During raw Doxia rendering, content is stored in multiple fields for later use when incorporating into skin or template: title, date, authors, head, body
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.Set<java.lang.String>
anchorsInSectionTitle
private java.util.List<java.lang.String>
authors
private java.lang.String
date
private java.io.StringWriter
headWriter
private boolean
isSectionTitle
private RenderingContext
renderingContext
private boolean
sectionHasID
private java.lang.StringBuilder
sectionTitleBuffer
private java.lang.StringBuilder
sectionTitleWriteBuffer
private java.lang.String
title
private java.io.Writer
writer
-
Fields inherited from class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
contentStack, 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, 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 Modifier Constructor Description private
SiteRendererSink(java.io.StringWriter writer, RenderingContext renderingContext)
Construct a new SiteRendererSink for a document.SiteRendererSink(RenderingContext renderingContext)
Construct a new SiteRendererSink for a document.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
anchor(java.lang.String name, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
void
author()
void
author_()
void
body()
Do nothing.void
body_()
Do nothing.void
date()
void
date_()
java.util.List<java.lang.String>
getAuthors()
Get the authors of the document.java.lang.String
getBody()
Get the html body of the document.java.lang.String
getDate()
Get the date of the document.java.lang.String
getHead()
Get the html head of the document.RenderingContext
getRenderingContext()
Get the document rendering context.java.lang.String
getTitle()
Get the title of the document.void
head()
void
head_()
protected void
onSectionTitle(int depth, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
protected void
onSectionTitle_(int depth)
void
text(java.lang.String text)
void
title()
Reset text buffer, since text content before title mustn't be in title.void
title_()
protected void
write(java.lang.String text)
-
Methods inherited from class org.apache.maven.doxia.module.xhtml5.Xhtml5Sink
isHeadTitleFlag, onSection, onSection_, setHeadTitleFlag
-
Methods inherited from class org.apache.maven.doxia.sink.impl.Xhtml5BaseSink
address, address, address_, anchor, anchor_, article, article, article_, blockquote, blockquote, blockquote_, bold, bold_, close, comment, content, content, content, content_, data, data, data_, definedTerm, definedTerm, definedTerm_, definition, definition, definition_, definitionList, definitionList, definitionList_, division, division, division_, encodeURL, escapeHTML, figure, figure, figure_, figureCaption, figureCaption, figureCaption_, figureGraphics, figureGraphics, flush, footer, footer, footer_, getCellCount, getCellJustif, getTextBuffer, header, header, header_, horizontalRule, horizontalRule, init, inline, inline, inline_, isHeadFlag, isVerbatimFlag, italic, italic_, lineBreak, lineBreak, lineBreakOpportunity, lineBreakOpportunity, link, link, link_, list, list, list_, listItem, listItem, listItem_, monospaced, monospaced_, navigation, navigation, navigation_, 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, sidebar, sidebar, sidebar_, table, table, table_, tableCaption, tableCaption, tableCaption_, tableCell, tableCell, tableCell, tableCell_, tableHeaderCell, tableHeaderCell, tableHeaderCell, tableHeaderCell_, tableRow, tableRow, tableRow_, tableRows, tableRows_, text, time, time, time_, unknown, verbatim, verbatim, verbatim_, verbatimContent, 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
author, body, date, definitionListItem, definitionListItem, definitionListItem_, head, section6, section6_, sectionTitle, sectionTitle_, sectionTitle6, sectionTitle6_, title
-
Methods inherited from class org.apache.maven.doxia.sink.impl.AbstractSink
enableLogging, getLog, unifyEOLs
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.maven.doxia.sink.Sink
address, address, address_, anchor, anchor_, article, article, article_, author, blockquote, blockquote, blockquote_, body, bold, bold_, close, comment, content, content, content_, data, data, data_, date, definedTerm, definedTerm, definedTerm_, definition, definition, definition_, definitionList, definitionList, definitionList_, definitionListItem, definitionListItem, definitionListItem_, division, division, division_, figure, figure, figure_, figureCaption, figureCaption, figureCaption_, figureGraphics, figureGraphics, flush, footer, footer, footer_, head, header, header, header_, horizontalRule, horizontalRule, inline, inline, inline_, italic, italic_, lineBreak, lineBreak, lineBreakOpportunity, lineBreakOpportunity, link, link, link_, list, list, list_, listItem, listItem, listItem_, monospaced, monospaced_, navigation, navigation, navigation_, nonBreakingSpace, numberedList, numberedList, numberedList_, numberedListItem, numberedListItem, numberedListItem_, pageBreak, paragraph, paragraph, paragraph_, rawText, section, section_, section1, section1_, section2, section2_, section3, section3_, section4, section4_, section5, section5_, section6, section6_, sectionTitle, sectionTitle, sectionTitle_, sectionTitle_, sectionTitle1, sectionTitle1_, sectionTitle2, sectionTitle2_, sectionTitle3, sectionTitle3_, sectionTitle4, sectionTitle4_, sectionTitle5, sectionTitle5_, sectionTitle6, sectionTitle6_, sidebar, sidebar, sidebar_, table, table, table_, tableCaption, tableCaption, tableCaption_, tableCell, tableCell, tableCell, tableCell_, tableHeaderCell, tableHeaderCell, tableHeaderCell, tableHeaderCell_, tableRow, tableRow, tableRow_, tableRows, tableRows_, text, time, time, time_, title, unknown, verbatim, verbatim, verbatim_
-
-
-
-
Field Detail
-
date
private java.lang.String date
-
title
private java.lang.String title
-
authors
private java.util.List<java.lang.String> authors
-
headWriter
private final java.io.StringWriter headWriter
-
sectionTitleBuffer
private java.lang.StringBuilder sectionTitleBuffer
-
sectionTitleWriteBuffer
private java.lang.StringBuilder sectionTitleWriteBuffer
-
sectionHasID
private boolean sectionHasID
-
isSectionTitle
private boolean isSectionTitle
-
anchorsInSectionTitle
private java.util.Set<java.lang.String> anchorsInSectionTitle
-
writer
private final java.io.Writer writer
-
renderingContext
private RenderingContext renderingContext
-
-
Constructor Detail
-
SiteRendererSink
public SiteRendererSink(RenderingContext renderingContext)
Construct a new SiteRendererSink for a document.- Parameters:
renderingContext
- the document's RenderingContext.
-
SiteRendererSink
private SiteRendererSink(java.io.StringWriter writer, RenderingContext renderingContext)
Construct a new SiteRendererSink for a document.- Parameters:
writer
- the writer for the sink.renderingContext
- the document's RenderingContext.
-
-
Method Detail
-
title_
public void title_()
- Specified by:
title_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
title_
in classorg.apache.maven.doxia.module.xhtml5.Xhtml5Sink
-
title
public void title()
Reset text buffer, since text content before title mustn't be in title.- Specified by:
title
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
title
in classorg.apache.maven.doxia.module.xhtml5.Xhtml5Sink
- See Also:
Xhtml5Sink.title()
-
author
public void author()
- Specified by:
author
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
author
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
author_
public void author_()
- Specified by:
author_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
author_
in classorg.apache.maven.doxia.module.xhtml5.Xhtml5Sink
-
date
public void date()
- Specified by:
date
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
date
in classorg.apache.maven.doxia.sink.impl.SinkAdapter
-
date_
public void date_()
- Specified by:
date_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
date_
in classorg.apache.maven.doxia.module.xhtml5.Xhtml5Sink
-
body_
public void body_()
Do nothing.- Specified by:
body_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
body_
in classorg.apache.maven.doxia.module.xhtml5.Xhtml5Sink
- See Also:
Xhtml5Sink.body_()
-
body
public void body()
Do nothing.- Specified by:
body
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
body
in classorg.apache.maven.doxia.module.xhtml5.Xhtml5Sink
- See Also:
Xhtml5Sink.body()
-
head_
public void head_()
- Specified by:
head_
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
head_
in classorg.apache.maven.doxia.module.xhtml5.Xhtml5Sink
-
head
public void head()
- Specified by:
head
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
head
in classorg.apache.maven.doxia.module.xhtml5.Xhtml5Sink
-
anchor
public void anchor(java.lang.String name, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
- Specified by:
anchor
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
anchor
in classorg.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
onSectionTitle
protected void onSectionTitle(int depth, org.apache.maven.doxia.sink.SinkEventAttributes attributes)
- Overrides:
onSectionTitle
in classorg.apache.maven.doxia.module.xhtml5.Xhtml5Sink
-
onSectionTitle_
protected void onSectionTitle_(int depth)
- Overrides:
onSectionTitle_
in classorg.apache.maven.doxia.module.xhtml5.Xhtml5Sink
-
text
public void text(java.lang.String text)
- Specified by:
text
in interfaceorg.apache.maven.doxia.sink.Sink
- Overrides:
text
in classorg.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
write
protected void write(java.lang.String text)
- Overrides:
write
in classorg.apache.maven.doxia.sink.impl.Xhtml5BaseSink
-
getTitle
public java.lang.String getTitle()
Get the title of the document.- Specified by:
getTitle
in interfaceDocumentContent
- Returns:
- the document title
-
getAuthors
public java.util.List<java.lang.String> getAuthors()
Get the authors of the document.- Specified by:
getAuthors
in interfaceDocumentContent
- Returns:
- the document authors
-
getDate
public java.lang.String getDate()
Get the date of the document.- Specified by:
getDate
in interfaceDocumentContent
- Returns:
- the document date
-
getBody
public java.lang.String getBody()
Get the html body of the document.- Specified by:
getBody
in interfaceDocumentContent
- Returns:
- the document body head
-
getHead
public java.lang.String getHead()
Get the html head of the document.- Specified by:
getHead
in interfaceDocumentContent
- Returns:
- the document html head
-
getRenderingContext
public RenderingContext getRenderingContext()
Get the document rendering context.- Specified by:
getRenderingContext
in interfaceDocumentContent
- Returns:
- the document rendering context
-
-