org.apache.maven.doxia.module.apt
Class AptSink

java.lang.Object
  org.apache.maven.doxia.sink.AbstractSink
      org.apache.maven.doxia.sink.SinkAdapter
          org.apache.maven.doxia.sink.AbstractTextSink
              org.apache.maven.doxia.module.apt.AptSink

All Implemented Interfaces:

org.apache.maven.doxia.logging.LogEnabled, Markup, TextMarkup, AptMarkup, Sink

public class AptSink
extends AbstractTextSink
implements AptMarkup

APT generator implementation.
Note: The encoding used is UTF-8.

Since:

1.0

Version:

$Id: AptSink.java 1091053 2011-04-11 12:55:07Z ltheussl $

Author:

eredmond

Field Summary

Fields inherited from interface org.apache.maven.doxia.module.apt.AptMarkup

ANCHOR_END_MARKUP, ANCHOR_START_MARKUP, BACKSLASH, BOLD_END_MARKUP, BOLD_START_MARKUP, BOXED_VERBATIM_END_MARKUP, BOXED_VERBATIM_START_MARKUP, COMMENT, HEADER_START_MARKUP, HORIZONTAL_RULE_MARKUP, ITALIC_END_MARKUP, ITALIC_START_MARKUP, LINK_END_MARKUP, LINK_START_1_MARKUP, LINK_START_2_MARKUP, LIST_END_MARKUP, LIST_START_MARKUP, MONOSPACED_END_MARKUP, MONOSPACED_START_MARKUP, NON_BOXED_VERBATIM_END_MARKUP, NON_BOXED_VERBATIM_START_MARKUP, NON_BREAKING_SPACE_MARKUP, NUMBERING, NUMBERING_LOWER_ALPHA_CHAR, NUMBERING_LOWER_ROMAN_CHAR, NUMBERING_UPPER_ALPHA_CHAR, NUMBERING_UPPER_ROMAN_CHAR, PAGE_BREAK, PAGE_BREAK_MARKUP, PERCENT, SECTION_TITLE_START_MARKUP, TAB, TABLE_CELL_SEPARATOR_MARKUP, TABLE_COL_CENTERED_ALIGNED_MARKUP, TABLE_COL_LEFT_ALIGNED_MARKUP, TABLE_COL_RIGHT_ALIGNED_MARKUP, TABLE_ROW_SEPARATOR_MARKUP, TABLE_ROW_START_MARKUP

Fields inherited from interface org.apache.maven.doxia.markup.TextMarkup

PIPE

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

Constructor Summary

protected

AptSink(Writer writer) Constructor, initialize the Writer and the variables.

Method Summary

void	anchor_()
void	anchor(String name)
void	author_()
void	bold_()
void	bold()
void	close()
void	comment(String comment)
protected void	content(String text) Write Apt escaped text to output.
void	date_()
void	definedTerm_()
void	definedTerm()
void	definition_()
void	definition()
void	definitionList_()
void	definitionList()
void	figureCaption_()
void	figureGraphics(String name)
void	flush()
protected StringBuffer	getBuffer() Returns the buffer that holds the current text.
void	head_()
void	head()
void	horizontalRule()
protected void	init()
void	italic_()
void	italic()
void	lineBreak()
void	link_()
void	link(String name)
void	link(String name, String target) A link with a target.
void	list_()
void	list()
void	listItem_()
void	listItem()
void	monospaced_()
void	monospaced()
void	nonBreakingSpace()
void	numberedList_()
void	numberedList(int numbering)
void	numberedListItem_()
void	numberedListItem()
void	pageBreak()
void	paragraph_()
void	paragraph()
void	rawText(String text)
protected void	resetBuffer() Reset the StringBuffer.
protected void	resetState() Deprecated. since 1.1.2, use init() instead of.
protected void	resetTableCaptionBuffer() Reset the TableCaptionBuffer.
void	section1_()
void	section2_()
void	section3_()
void	section4_()
void	section5_()
void	sectionTitle1_()
void	sectionTitle1()
void	sectionTitle2_()
void	sectionTitle2()
void	sectionTitle3_()
void	sectionTitle3()
void	sectionTitle4_()
void	sectionTitle4()
void	sectionTitle5_()
void	sectionTitle5()
protected void	setHeadFlag(boolean headFlag) Used to determine whether we are in head mode.
void	table_()
void	table()
void	tableCaption_()
void	tableCaption()
void	tableCell_()
void	tableCell()
void	tableCell(boolean headerRow) Starts a table cell.
void	tableHeaderCell_()
void	tableHeaderCell()
void	tableRow_()
void	tableRow()
void	tableRows_()
void	tableRows(int[] justification, boolean grid)
void	text(String text)
void	title_()
void	unknown(String name, Object[] requiredParams, SinkEventAttributes attributes) Unkown events just log a warning message but are ignored otherwise.
void	verbatim_()
void	verbatim(boolean boxed)
protected void	verbatimContent(String text) Write Apt escaped text to output.
protected void	write(String text) Write text to output.

Methods inherited from class org.apache.maven.doxia.sink.SinkAdapter

anchor, author, author, body_, body, body, date, date, definedTerm, definition, definitionList, definitionListItem_, definitionListItem, definitionListItem, figure_, figure, figure, figureCaption, figureCaption, figureGraphics, head, horizontalRule, lineBreak, link, list, listItem, numberedList, numberedListItem, paragraph, section_, section, section1, section2, section3, section4, section5, sectionTitle_, sectionTitle_, sectionTitle, sectionTitle, table, tableCaption, tableCell, tableCell, tableHeaderCell, tableHeaderCell, tableRow, text, title, title, verbatim

Methods inherited from class org.apache.maven.doxia.sink.AbstractSink

enableLogging, getLog, unifyEOLs

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AptSink

protected AptSink(Writer writer)

Constructor, initialize the Writer and the variables.

Parameters:

writer - not null writer to write the result. Should be an UTF-8 Writer. You could use newWriter methods from WriterFactory.

Method Detail

getBuffer

protected StringBuffer getBuffer()

Returns the buffer that holds the current text.

Returns:

A StringBuffer.

setHeadFlag

protected void setHeadFlag(boolean headFlag)

Used to determine whether we are in head mode.

Parameters:

headFlag - True for head mode.

resetState

protected void resetState()

Deprecated. since 1.1.2, use init() instead of.

Reset all variables.

init

protected void init()

Overrides:

init in class AbstractSink

resetBuffer

protected void resetBuffer()

Reset the StringBuffer.

resetTableCaptionBuffer

protected void resetTableCaptionBuffer()

Reset the TableCaptionBuffer.

head

public void head()

Specified by:

head in interface Sink

Overrides:

head in class SinkAdapter

head_

public void head_()

Specified by:

head_ in interface Sink

Overrides:

head_ in class SinkAdapter

title_

public void title_()

Specified by:

title_ in interface Sink

Overrides:

title_ in class SinkAdapter

author_

public void author_()

Specified by:

author_ in interface Sink

Overrides:

author_ in class SinkAdapter

date_

public void date_()

Specified by:

date_ in interface Sink

Overrides:

date_ in class SinkAdapter

section1_

public void section1_()

Specified by:

section1_ in interface Sink

Overrides:

section1_ in class SinkAdapter

section2_

public void section2_()

Specified by:

section2_ in interface Sink

Overrides:

section2_ in class SinkAdapter

section3_

public void section3_()

Specified by:

section3_ in interface Sink

Overrides:

section3_ in class SinkAdapter

section4_

public void section4_()

Specified by:

section4_ in interface Sink

Overrides:

section4_ in class SinkAdapter

section5_

public void section5_()

Specified by:

section5_ in interface Sink

Overrides:

section5_ in class SinkAdapter

sectionTitle1

public void sectionTitle1()

Specified by:

sectionTitle1 in interface Sink

Overrides:

sectionTitle1 in class SinkAdapter

sectionTitle1_

public void sectionTitle1_()

Specified by:

sectionTitle1_ in interface Sink

Overrides:

sectionTitle1_ in class SinkAdapter

sectionTitle2

public void sectionTitle2()

Specified by:

sectionTitle2 in interface Sink

Overrides:

sectionTitle2 in class SinkAdapter

sectionTitle2_

public void sectionTitle2_()

Specified by:

sectionTitle2_ in interface Sink

Overrides:

sectionTitle2_ in class SinkAdapter

sectionTitle3

public void sectionTitle3()

Specified by:

sectionTitle3 in interface Sink

Overrides:

sectionTitle3 in class SinkAdapter

sectionTitle3_

public void sectionTitle3_()

Specified by:

sectionTitle3_ in interface Sink

Overrides:

sectionTitle3_ in class SinkAdapter

sectionTitle4

public void sectionTitle4()

Specified by:

sectionTitle4 in interface Sink

Overrides:

sectionTitle4 in class SinkAdapter

sectionTitle4_

public void sectionTitle4_()

Specified by:

sectionTitle4_ in interface Sink

Overrides:

sectionTitle4_ in class SinkAdapter

sectionTitle5

public void sectionTitle5()

Specified by:

sectionTitle5 in interface Sink

Overrides:

sectionTitle5 in class SinkAdapter

sectionTitle5_

public void sectionTitle5_()

Specified by:

sectionTitle5_ in interface Sink

Overrides:

sectionTitle5_ in class SinkAdapter

list

public void list()

Specified by:

list in interface Sink

Overrides:

list in class SinkAdapter

list_

public void list_()

Specified by:

list_ in interface Sink

Overrides:

list_ in class SinkAdapter

listItem

public void listItem()

Specified by:

listItem in interface Sink

Overrides:

listItem in class SinkAdapter

listItem_

public void listItem_()

Specified by:

listItem_ in interface Sink

Overrides:

listItem_ in class SinkAdapter

numberedList

public void numberedList(int numbering)

Specified by:

numberedList in interface Sink

Overrides:

numberedList in class SinkAdapter

numberedList_

public void numberedList_()

Specified by:

numberedList_ in interface Sink

Overrides:

numberedList_ in class SinkAdapter

numberedListItem

public void numberedListItem()

Specified by:

numberedListItem in interface Sink

Overrides:

numberedListItem in class SinkAdapter

numberedListItem_

public void numberedListItem_()

Specified by:

numberedListItem_ in interface Sink

Overrides:

numberedListItem_ in class SinkAdapter

definitionList

public void definitionList()

Specified by:

definitionList in interface Sink

Overrides:

definitionList in class SinkAdapter

definitionList_

public void definitionList_()

Specified by:

definitionList_ in interface Sink

Overrides:

definitionList_ in class SinkAdapter

definedTerm

public void definedTerm()

Specified by:

definedTerm in interface Sink

Overrides:

definedTerm in class SinkAdapter

definedTerm_

public void definedTerm_()

Specified by:

definedTerm_ in interface Sink

Overrides:

definedTerm_ in class SinkAdapter

definition

public void definition()

Specified by:

definition in interface Sink

Overrides:

definition in class SinkAdapter

definition_

public void definition_()

Specified by:

definition_ in interface Sink

Overrides:

definition_ in class SinkAdapter

pageBreak

public void pageBreak()

Specified by:

pageBreak in interface Sink

Overrides:

pageBreak in class SinkAdapter

paragraph

public void paragraph()

Specified by:

paragraph in interface Sink

Overrides:

paragraph in class SinkAdapter

paragraph_

public void paragraph_()

Specified by:

paragraph_ in interface Sink

Overrides:

paragraph_ in class SinkAdapter

verbatim

public void verbatim(boolean boxed)

Specified by:

verbatim in interface Sink

Overrides:

verbatim in class SinkAdapter

verbatim_

public void verbatim_()

Specified by:

verbatim_ in interface Sink

Overrides:

verbatim_ in class SinkAdapter

horizontalRule

public void horizontalRule()

Specified by:

horizontalRule in interface Sink

Overrides:

horizontalRule in class SinkAdapter

table

public void table()

Specified by:

table in interface Sink

Overrides:

table in class SinkAdapter

table_

public void table_()

Specified by:

table_ in interface Sink

Overrides:

table_ in class SinkAdapter

tableRows

public void tableRows(int[] justification,
                      boolean grid)

Specified by:

tableRows in interface Sink

Overrides:

tableRows in class SinkAdapter

tableRows_

public void tableRows_()

Specified by:

tableRows_ in interface Sink

Overrides:

tableRows_ in class SinkAdapter

tableRow

public void tableRow()

Specified by:

tableRow in interface Sink

Overrides:

tableRow in class SinkAdapter

tableRow_

public void tableRow_()

Specified by:

tableRow_ in interface Sink

Overrides:

tableRow_ in class SinkAdapter

tableCell

public void tableCell()

Specified by:

tableCell in interface Sink

Overrides:

tableCell in class SinkAdapter

tableHeaderCell

public void tableHeaderCell()

Specified by:

tableHeaderCell in interface Sink

Overrides:

tableHeaderCell in class SinkAdapter

tableCell

public void tableCell(boolean headerRow)

Starts a table cell.

Parameters:

headerRow - If this cell is part of a header row.

tableCell_

public void tableCell_()

Specified by:

tableCell_ in interface Sink

Overrides:

tableCell_ in class SinkAdapter

tableHeaderCell_

public void tableHeaderCell_()

Specified by:

tableHeaderCell_ in interface Sink

Overrides:

tableHeaderCell_ in class SinkAdapter

tableCaption

public void tableCaption()

Specified by:

tableCaption in interface Sink

Overrides:

tableCaption in class SinkAdapter

tableCaption_

public void tableCaption_()

Specified by:

tableCaption_ in interface Sink

Overrides:

tableCaption_ in class SinkAdapter

figureCaption_

public void figureCaption_()

Specified by:

figureCaption_ in interface Sink

Overrides:

figureCaption_ in class SinkAdapter

figureGraphics

public void figureGraphics(String name)

Specified by:

figureGraphics in interface Sink

Overrides:

figureGraphics in class SinkAdapter

anchor

public void anchor(String name)

Specified by:

anchor in interface Sink

Overrides:

anchor in class SinkAdapter

anchor_

public void anchor_()

Specified by:

anchor_ in interface Sink

Overrides:

anchor_ in class SinkAdapter

link

public void link(String name)

Specified by:

link in interface Sink

Overrides:

link in class SinkAdapter

link_

public void link_()

Specified by:

link_ in interface Sink

Overrides:

link_ in class SinkAdapter

link

public void link(String name,
                 String target)

A link with a target.

Parameters:

name - The name of the link.

target - The link target.

italic

public void italic()

Specified by:

italic in interface Sink

Overrides:

italic in class SinkAdapter

italic_

public void italic_()

Specified by:

italic_ in interface Sink

Overrides:

italic_ in class SinkAdapter

bold

public void bold()

Specified by:

bold in interface Sink

Overrides:

bold in class SinkAdapter

bold_

public void bold_()

Specified by:

bold_ in interface Sink

Overrides:

bold_ in class SinkAdapter

monospaced

public void monospaced()

Specified by:

monospaced in interface Sink

Overrides:

monospaced in class SinkAdapter

monospaced_

public void monospaced_()

Specified by:

monospaced_ in interface Sink

Overrides:

monospaced_ in class SinkAdapter

lineBreak

public void lineBreak()

Specified by:

lineBreak in interface Sink

Overrides:

lineBreak in class SinkAdapter

nonBreakingSpace

public void nonBreakingSpace()

Specified by:

nonBreakingSpace in interface Sink

Overrides:

nonBreakingSpace in class SinkAdapter

text

public void text(String text)

Specified by:

text in interface Sink

Overrides:

text in class SinkAdapter

rawText

public void rawText(String text)

Specified by:

rawText in interface Sink

Overrides:

rawText in class SinkAdapter

comment

public void comment(String comment)

Specified by:

comment in interface Sink

Overrides:

comment in class SinkAdapter

unknown

public void unknown(String name,
                    Object[] requiredParams,
                    SinkEventAttributes attributes)

Unkown events just log a warning message but are ignored otherwise.

Specified by:

unknown in interface Sink

Overrides:

unknown in class SinkAdapter

See Also:

Sink.unknown(String,Object[],SinkEventAttributes)

write

protected void write(String text)

Write text to output.

Parameters:

text - The text to write.

content

protected void content(String text)

Write Apt escaped text to output.

Parameters:

text - The text to write.

verbatimContent

protected void verbatimContent(String text)

Write Apt escaped text to output.

Parameters:

text - The text to write.

flush

public void flush()

Specified by:

flush in interface Sink

Overrides:

flush in class SinkAdapter

close

public void close()

Specified by:

close in interface Sink

Overrides:

close in class SinkAdapter