AptSink

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

All Implemented Interfaces:

org.apache.maven.doxia.markup.Markup, org.apache.maven.doxia.markup.TextMarkup, AptMarkup
```
public class AptSink
extends org.apache.maven.doxia.sink.impl.AbstractTextSink
implements AptMarkup
```
APT generator implementation.
Note: The encoding used is UTF-8.

Since:

1.0

Version:

$Id: AptSink.java 1726411 2016-01-23 16:34:09Z hboutemy $

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.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
- Fields inherited from interface org.apache.maven.doxia.markup.TextMarkup
  PIPE

Constructor Summary

Constructors
Modifier Constructor Description

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

Constructors
Modifier	Constructor	Description
`protected`	`AptSink(java.io.Writer writer)`	Constructor, initialize the Writer and the variables.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`anchor(java.lang.String name)`
`void`	`anchor_()`
`void`	`author_()`
`void`	`bold()`
`void`	`bold_()`
`void`	`close()`
`void`	`comment(java.lang.String comment)`
`protected void`	`content(java.lang.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(java.lang.String name)`
`void`	`flush()`
`protected java.lang.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(java.lang.String name)`
`void`	`link(java.lang.String name, java.lang.String target)`	A link with a target.
`void`	`link_()`
`void`	`list()`
`void`	`list_()`
`void`	`listItem()`
`void`	`listItem_()`
`void`	`monospaced()`
`void`	`monospaced_()`
`void`	`nonBreakingSpace()`
`void`	`numberedList(int numbering)`
`void`	`numberedList_()`
`void`	`numberedListItem()`
`void`	`numberedListItem_()`
`void`	`pageBreak()`
`void`	`paragraph()`
`void`	`paragraph_()`
`void`	`rawText(java.lang.String text)`
`protected void`	`resetBuffer()`	Reset the StringBuilder.
`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(boolean headerRow)`	Starts a table cell.
`void`	`tableCell_()`
`void`	`tableHeaderCell()`
`void`	`tableHeaderCell_()`
`void`	`tableRow()`
`void`	`tableRow_()`
`void`	`tableRows(int[] justification, boolean grid)`
`void`	`tableRows_()`
`void`	`text(java.lang.String text)`
`void`	`title_()`
`void`	`unknown(java.lang.String name, java.lang.Object[] requiredParams, org.apache.maven.doxia.sink.SinkEventAttributes attributes)`	Unkown events just log a warning message but are ignored otherwise.
`void`	`verbatim(boolean boxed)`
`void`	`verbatim_()`
`protected void`	`verbatimContent(java.lang.String text)`	Write Apt escaped text to output.
`protected void`	`write(java.lang.String text)`	Write text to output.

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 class org.apache.maven.doxia.sink.impl.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, section6, section6_, sectionTitle, sectionTitle, sectionTitle_, sectionTitle_, sectionTitle6, sectionTitle6_, table, tableCaption, tableCell, tableCell, tableHeaderCell, tableHeaderCell, tableRow, text, title, title, verbatim

- Constructor Detail
  - AptSink
```
protected AptSink(java.io.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 java.lang.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 org.apache.maven.doxia.sink.impl.AbstractSink
  - resetBuffer
```
protected void resetBuffer()
```
    Reset the StringBuilder.
  - resetTableCaptionBuffer
```
protected void resetTableCaptionBuffer()
```
    Reset the TableCaptionBuffer.
  - head
```
public void head()
```
    Overrides:
    
    head in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - head_
```
public void head_()
```
    Overrides:
    
    head_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - title_
```
public void title_()
```
    Overrides:
    
    title_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - author_
```
public void author_()
```
    Overrides:
    
    author_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - date_
```
public void date_()
```
    Overrides:
    
    date_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - section1_
```
public void section1_()
```
    Overrides:
    
    section1_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - section2_
```
public void section2_()
```
    Overrides:
    
    section2_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - section3_
```
public void section3_()
```
    Overrides:
    
    section3_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - section4_
```
public void section4_()
```
    Overrides:
    
    section4_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - section5_
```
public void section5_()
```
    Overrides:
    
    section5_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - sectionTitle1
```
public void sectionTitle1()
```
    Overrides:
    
    sectionTitle1 in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - sectionTitle1_
```
public void sectionTitle1_()
```
    Overrides:
    
    sectionTitle1_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - sectionTitle2
```
public void sectionTitle2()
```
    Overrides:
    
    sectionTitle2 in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - sectionTitle2_
```
public void sectionTitle2_()
```
    Overrides:
    
    sectionTitle2_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - sectionTitle3
```
public void sectionTitle3()
```
    Overrides:
    
    sectionTitle3 in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - sectionTitle3_
```
public void sectionTitle3_()
```
    Overrides:
    
    sectionTitle3_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - sectionTitle4
```
public void sectionTitle4()
```
    Overrides:
    
    sectionTitle4 in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - sectionTitle4_
```
public void sectionTitle4_()
```
    Overrides:
    
    sectionTitle4_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - sectionTitle5
```
public void sectionTitle5()
```
    Overrides:
    
    sectionTitle5 in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - sectionTitle5_
```
public void sectionTitle5_()
```
    Overrides:
    
    sectionTitle5_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - list
```
public void list()
```
    Overrides:
    
    list in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - list_
```
public void list_()
```
    Overrides:
    
    list_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - listItem
```
public void listItem()
```
    Overrides:
    
    listItem in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - listItem_
```
public void listItem_()
```
    Overrides:
    
    listItem_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - numberedList
```
public void numberedList(int numbering)
```
    Overrides:
    
    numberedList in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - numberedList_
```
public void numberedList_()
```
    Overrides:
    
    numberedList_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - numberedListItem
```
public void numberedListItem()
```
    Overrides:
    
    numberedListItem in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - numberedListItem_
```
public void numberedListItem_()
```
    Overrides:
    
    numberedListItem_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - definitionList
```
public void definitionList()
```
    Overrides:
    
    definitionList in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - definitionList_
```
public void definitionList_()
```
    Overrides:
    
    definitionList_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - definedTerm
```
public void definedTerm()
```
    Overrides:
    
    definedTerm in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - definedTerm_
```
public void definedTerm_()
```
    Overrides:
    
    definedTerm_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - definition
```
public void definition()
```
    Overrides:
    
    definition in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - definition_
```
public void definition_()
```
    Overrides:
    
    definition_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - pageBreak
```
public void pageBreak()
```
    Overrides:
    
    pageBreak in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - paragraph
```
public void paragraph()
```
    Overrides:
    
    paragraph in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - paragraph_
```
public void paragraph_()
```
    Overrides:
    
    paragraph_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - verbatim
```
public void verbatim(boolean boxed)
```
    Overrides:
    
    verbatim in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - verbatim_
```
public void verbatim_()
```
    Overrides:
    
    verbatim_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - horizontalRule
```
public void horizontalRule()
```
    Overrides:
    
    horizontalRule in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - table
```
public void table()
```
    Overrides:
    
    table in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - table_
```
public void table_()
```
    Overrides:
    
    table_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - tableRows
```
public void tableRows(int[] justification,
                      boolean grid)
```
    Overrides:
    
    tableRows in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - tableRows_
```
public void tableRows_()
```
    Overrides:
    
    tableRows_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - tableRow
```
public void tableRow()
```
    Overrides:
    
    tableRow in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - tableRow_
```
public void tableRow_()
```
    Overrides:
    
    tableRow_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - tableCell
```
public void tableCell()
```
    Overrides:
    
    tableCell in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - tableHeaderCell
```
public void tableHeaderCell()
```
    Overrides:
    
    tableHeaderCell in class org.apache.maven.doxia.sink.impl.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_()
```
    Overrides:
    
    tableCell_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - tableHeaderCell_
```
public void tableHeaderCell_()
```
    Overrides:
    
    tableHeaderCell_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - tableCaption
```
public void tableCaption()
```
    Overrides:
    
    tableCaption in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - tableCaption_
```
public void tableCaption_()
```
    Overrides:
    
    tableCaption_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - figureCaption_
```
public void figureCaption_()
```
    Overrides:
    
    figureCaption_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - figureGraphics
```
public void figureGraphics(java.lang.String name)
```
    Overrides:
    
    figureGraphics in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - anchor
```
public void anchor(java.lang.String name)
```
    Overrides:
    
    anchor in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - anchor_
```
public void anchor_()
```
    Overrides:
    
    anchor_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - link
```
public void link(java.lang.String name)
```
    Overrides:
    
    link in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - link_
```
public void link_()
```
    Overrides:
    
    link_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - link
```
public void link(java.lang.String name,
                 java.lang.String target)
```
    A link with a target.
    
    Parameters:
    
    name - The name of the link.
    
    target - The link target.
  - italic
```
public void italic()
```
    Overrides:
    
    italic in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - italic_
```
public void italic_()
```
    Overrides:
    
    italic_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - bold
```
public void bold()
```
    Overrides:
    
    bold in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - bold_
```
public void bold_()
```
    Overrides:
    
    bold_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - monospaced
```
public void monospaced()
```
    Overrides:
    
    monospaced in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - monospaced_
```
public void monospaced_()
```
    Overrides:
    
    monospaced_ in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - lineBreak
```
public void lineBreak()
```
    Overrides:
    
    lineBreak in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - nonBreakingSpace
```
public void nonBreakingSpace()
```
    Overrides:
    
    nonBreakingSpace in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - text
```
public void text(java.lang.String text)
```
    Overrides:
    
    text in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - rawText
```
public void rawText(java.lang.String text)
```
    Overrides:
    
    rawText in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - comment
```
public void comment(java.lang.String comment)
```
    Overrides:
    
    comment in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - unknown
```
public void unknown(java.lang.String name,
                    java.lang.Object[] requiredParams,
                    org.apache.maven.doxia.sink.SinkEventAttributes attributes)
```
    Unkown events just log a warning message but are ignored otherwise.
    
    Overrides:
    
    unknown in class org.apache.maven.doxia.sink.impl.SinkAdapter
    
    See Also:
    
    Sink.unknown(String,Object[],SinkEventAttributes)
  - write
```
protected void write(java.lang.String text)
```
    Write text to output.
    
    Parameters:
    
    text - The text to write.
  - content
```
protected void content(java.lang.String text)
```
    Write Apt escaped text to output.
    
    Parameters:
    
    text - The text to write.
  - verbatimContent
```
protected void verbatimContent(java.lang.String text)
```
    Write Apt escaped text to output.
    
    Parameters:
    
    text - The text to write.
  - flush
```
public void flush()
```
    Overrides:
    
    flush in class org.apache.maven.doxia.sink.impl.SinkAdapter
  - close
```
public void close()
```
    Overrides:
    
    close in class org.apache.maven.doxia.sink.impl.SinkAdapter

Class AptSink

Field Summary

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

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

Fields inherited from interface org.apache.maven.doxia.sink.Sink

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

AptSink

Method Detail

getBuffer

setHeadFlag

resetState

init

resetBuffer

resetTableCaptionBuffer

head

head_

title_

author_

date_

section1_

section2_

section3_

section4_

section5_

sectionTitle1

sectionTitle1_

sectionTitle2

sectionTitle2_

sectionTitle3

sectionTitle3_

sectionTitle4

sectionTitle4_

sectionTitle5

sectionTitle5_

list

list_

listItem

listItem_

numberedList

numberedList_

numberedListItem

numberedListItem_

definitionList

definitionList_

definedTerm

definedTerm_

definition

definition_

pageBreak

paragraph

paragraph_

verbatim

verbatim_

horizontalRule

table

table_

tableRows

tableRows_

tableRow

tableRow_

tableCell

tableHeaderCell

tableCell

tableCell_

tableHeaderCell_

tableCaption

tableCaption_

figureCaption_

figureGraphics

anchor

anchor_

link

link_

link