Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

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

java.lang.Object
  extended by org.apache.maven.doxia.sink.SinkAdapter
      extended by org.apache.maven.doxia.sink.AbstractTextSink
          extended by org.apache.maven.doxia.module.apt.AptSink
All Implemented Interfaces:
org.apache.maven.doxia.markup.Markup, org.apache.maven.doxia.markup.TextMarkup, AptMarkup, org.apache.maven.doxia.sink.Sink
public class AptSink
extends org.apache.maven.doxia.sink.AbstractTextSink
implements AptMarkup

APT Sink implementation.

Since:
1.0
Version:
$Id: AptSink.java 572813 2007-09-04 20:46:47Z 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, COLON, 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
EOL, EQUAL, GREATER_THAN, LEFT_CURLY_BRACKET, LEFT_SQUARE_BRACKET, LESS_THAN, MINUS, PLUS, QUOTE, RIGHT_CURLY_BRACKET, RIGHT_SQUARE_BRACKET, SLASH, SPACE, STAR
 
Fields inherited from interface org.apache.maven.doxia.sink.Sink
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
AptSink(java.io.Writer writer)
          Constructor, initialize the variables.
 
Method Summary
 void anchor_()
          
 void anchor(java.lang.String name)
          
 void author_()
          
 void bold_()
          
 void bold()
          
 void close()
          
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()
          
static java.lang.String encodeFragment(java.lang.String text)
          Forward to HtmlTools.encodeFragment( text ).
static java.lang.String encodeURL(java.lang.String text)
          Forward to HtmlTools.encodeURL( text ).
 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()
          
 void italic_()
          
 void italic()
          
 void lineBreak()
          
 void link_()
          
 void link(java.lang.String name)
          
 void link(java.lang.String name, java.lang.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(java.lang.String text)
          
protected  void resetBuffer()
          Reset the StringBuffer.
protected  void resetState()
          Reset all variables.
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(java.lang.String text)
          
 void title_()
          
 void verbatim_()
          
 void verbatim(boolean boxed)
          
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.SinkAdapter
author, body_, body, date, definitionListItem_, definitionListItem, figure_, figure, figureCaption, section1, section2, section3, section4, section5, sectionTitle_, sectionTitle, tableCell, tableHeaderCell, title
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AptSink

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

Parameters:
writer - The writer to write the result.
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()
Reset all variables.

resetBuffer

protected void resetBuffer()
Reset the StringBuffer.

resetTableCaptionBuffer

protected void resetTableCaptionBuffer()
Reset the TableCaptionBuffer.

head

public void head()

Specified by:
head in interface org.apache.maven.doxia.sink.Sink
Overrides:
head in class org.apache.maven.doxia.sink.SinkAdapter

head_

public void head_()

Specified by:
head_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
head_ in class org.apache.maven.doxia.sink.SinkAdapter

title_

public void title_()

Specified by:
title_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
title_ in class org.apache.maven.doxia.sink.SinkAdapter

author_

public void author_()

Specified by:
author_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
author_ in class org.apache.maven.doxia.sink.SinkAdapter

date_

public void date_()

Specified by:
date_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
date_ in class org.apache.maven.doxia.sink.SinkAdapter

section1_

public void section1_()

Specified by:
section1_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
section1_ in class org.apache.maven.doxia.sink.SinkAdapter

section2_

public void section2_()

Specified by:
section2_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
section2_ in class org.apache.maven.doxia.sink.SinkAdapter

section3_

public void section3_()

Specified by:
section3_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
section3_ in class org.apache.maven.doxia.sink.SinkAdapter

section4_

public void section4_()

Specified by:
section4_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
section4_ in class org.apache.maven.doxia.sink.SinkAdapter

section5_

public void section5_()

Specified by:
section5_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
section5_ in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle1

public void sectionTitle1()

Specified by:
sectionTitle1 in interface org.apache.maven.doxia.sink.Sink
Overrides:
sectionTitle1 in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle1_

public void sectionTitle1_()

Specified by:
sectionTitle1_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
sectionTitle1_ in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle2

public void sectionTitle2()

Specified by:
sectionTitle2 in interface org.apache.maven.doxia.sink.Sink
Overrides:
sectionTitle2 in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle2_

public void sectionTitle2_()

Specified by:
sectionTitle2_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
sectionTitle2_ in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle3

public void sectionTitle3()

Specified by:
sectionTitle3 in interface org.apache.maven.doxia.sink.Sink
Overrides:
sectionTitle3 in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle3_

public void sectionTitle3_()

Specified by:
sectionTitle3_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
sectionTitle3_ in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle4

public void sectionTitle4()

Specified by:
sectionTitle4 in interface org.apache.maven.doxia.sink.Sink
Overrides:
sectionTitle4 in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle4_

public void sectionTitle4_()

Specified by:
sectionTitle4_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
sectionTitle4_ in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle5

public void sectionTitle5()

Specified by:
sectionTitle5 in interface org.apache.maven.doxia.sink.Sink
Overrides:
sectionTitle5 in class org.apache.maven.doxia.sink.SinkAdapter

sectionTitle5_

public void sectionTitle5_()

Specified by:
sectionTitle5_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
sectionTitle5_ in class org.apache.maven.doxia.sink.SinkAdapter

list

public void list()

Specified by:
list in interface org.apache.maven.doxia.sink.Sink
Overrides:
list in class org.apache.maven.doxia.sink.SinkAdapter

list_

public void list_()

Specified by:
list_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
list_ in class org.apache.maven.doxia.sink.SinkAdapter

listItem

public void listItem()

Specified by:
listItem in interface org.apache.maven.doxia.sink.Sink
Overrides:
listItem in class org.apache.maven.doxia.sink.SinkAdapter

listItem_

public void listItem_()

Specified by:
listItem_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
listItem_ in class org.apache.maven.doxia.sink.SinkAdapter

numberedList

public void numberedList(int numbering)

Specified by:
numberedList in interface org.apache.maven.doxia.sink.Sink
Overrides:
numberedList in class org.apache.maven.doxia.sink.SinkAdapter

numberedList_

public void numberedList_()

Specified by:
numberedList_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
numberedList_ in class org.apache.maven.doxia.sink.SinkAdapter

numberedListItem

public void numberedListItem()

Specified by:
numberedListItem in interface org.apache.maven.doxia.sink.Sink
Overrides:
numberedListItem in class org.apache.maven.doxia.sink.SinkAdapter

numberedListItem_

public void numberedListItem_()

Specified by:
numberedListItem_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
numberedListItem_ in class org.apache.maven.doxia.sink.SinkAdapter

definitionList

public void definitionList()

Specified by:
definitionList in interface org.apache.maven.doxia.sink.Sink
Overrides:
definitionList in class org.apache.maven.doxia.sink.SinkAdapter

definitionList_

public void definitionList_()

Specified by:
definitionList_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
definitionList_ in class org.apache.maven.doxia.sink.SinkAdapter

definedTerm

public void definedTerm()

Specified by:
definedTerm in interface org.apache.maven.doxia.sink.Sink
Overrides:
definedTerm in class org.apache.maven.doxia.sink.SinkAdapter

definedTerm_

public void definedTerm_()

Specified by:
definedTerm_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
definedTerm_ in class org.apache.maven.doxia.sink.SinkAdapter

definition

public void definition()

Specified by:
definition in interface org.apache.maven.doxia.sink.Sink
Overrides:
definition in class org.apache.maven.doxia.sink.SinkAdapter

definition_

public void definition_()

Specified by:
definition_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
definition_ in class org.apache.maven.doxia.sink.SinkAdapter

pageBreak

public void pageBreak()

Specified by:
pageBreak in interface org.apache.maven.doxia.sink.Sink
Overrides:
pageBreak in class org.apache.maven.doxia.sink.SinkAdapter

paragraph

public void paragraph()

Specified by:
paragraph in interface org.apache.maven.doxia.sink.Sink
Overrides:
paragraph in class org.apache.maven.doxia.sink.SinkAdapter

paragraph_

public void paragraph_()

Specified by:
paragraph_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
paragraph_ in class org.apache.maven.doxia.sink.SinkAdapter

verbatim

public void verbatim(boolean boxed)

Specified by:
verbatim in interface org.apache.maven.doxia.sink.Sink
Overrides:
verbatim in class org.apache.maven.doxia.sink.SinkAdapter

verbatim_

public void verbatim_()

Specified by:
verbatim_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
verbatim_ in class org.apache.maven.doxia.sink.SinkAdapter

horizontalRule

public void horizontalRule()

Specified by:
horizontalRule in interface org.apache.maven.doxia.sink.Sink
Overrides:
horizontalRule in class org.apache.maven.doxia.sink.SinkAdapter

table

public void table()

Specified by:
table in interface org.apache.maven.doxia.sink.Sink
Overrides:
table in class org.apache.maven.doxia.sink.SinkAdapter

table_

public void table_()

Specified by:
table_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
table_ in class org.apache.maven.doxia.sink.SinkAdapter

tableRows

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

Specified by:
tableRows in interface org.apache.maven.doxia.sink.Sink
Overrides:
tableRows in class org.apache.maven.doxia.sink.SinkAdapter

tableRows_

public void tableRows_()

Specified by:
tableRows_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
tableRows_ in class org.apache.maven.doxia.sink.SinkAdapter

tableRow

public void tableRow()

Specified by:
tableRow in interface org.apache.maven.doxia.sink.Sink
Overrides:
tableRow in class org.apache.maven.doxia.sink.SinkAdapter

tableRow_

public void tableRow_()

Specified by:
tableRow_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
tableRow_ in class org.apache.maven.doxia.sink.SinkAdapter

tableCell

public void tableCell()

Specified by:
tableCell in interface org.apache.maven.doxia.sink.Sink
Overrides:
tableCell in class org.apache.maven.doxia.sink.SinkAdapter

tableHeaderCell

public void tableHeaderCell()

Specified by:
tableHeaderCell in interface org.apache.maven.doxia.sink.Sink
Overrides:
tableHeaderCell in class org.apache.maven.doxia.sink.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 org.apache.maven.doxia.sink.Sink
Overrides:
tableCell_ in class org.apache.maven.doxia.sink.SinkAdapter

tableHeaderCell_

public void tableHeaderCell_()

Specified by:
tableHeaderCell_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
tableHeaderCell_ in class org.apache.maven.doxia.sink.SinkAdapter

tableCaption

public void tableCaption()

Specified by:
tableCaption in interface org.apache.maven.doxia.sink.Sink
Overrides:
tableCaption in class org.apache.maven.doxia.sink.SinkAdapter

tableCaption_

public void tableCaption_()

Specified by:
tableCaption_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
tableCaption_ in class org.apache.maven.doxia.sink.SinkAdapter

figureCaption_

public void figureCaption_()

Specified by:
figureCaption_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
figureCaption_ in class org.apache.maven.doxia.sink.SinkAdapter

figureGraphics

public void figureGraphics(java.lang.String name)

Specified by:
figureGraphics in interface org.apache.maven.doxia.sink.Sink
Overrides:
figureGraphics in class org.apache.maven.doxia.sink.SinkAdapter

anchor

public void anchor(java.lang.String name)

Specified by:
anchor in interface org.apache.maven.doxia.sink.Sink
Overrides:
anchor in class org.apache.maven.doxia.sink.SinkAdapter

anchor_

public void anchor_()

Specified by:
anchor_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
anchor_ in class org.apache.maven.doxia.sink.SinkAdapter

link

public void link(java.lang.String name)

Specified by:
link in interface org.apache.maven.doxia.sink.Sink
Overrides:
link in class org.apache.maven.doxia.sink.SinkAdapter

link_

public void link_()

Specified by:
link_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
link_ in class org.apache.maven.doxia.sink.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()

Specified by:
italic in interface org.apache.maven.doxia.sink.Sink
Overrides:
italic in class org.apache.maven.doxia.sink.SinkAdapter

italic_

public void italic_()

Specified by:
italic_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
italic_ in class org.apache.maven.doxia.sink.SinkAdapter

bold

public void bold()

Specified by:
bold in interface org.apache.maven.doxia.sink.Sink
Overrides:
bold in class org.apache.maven.doxia.sink.SinkAdapter

bold_

public void bold_()

Specified by:
bold_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
bold_ in class org.apache.maven.doxia.sink.SinkAdapter

monospaced

public void monospaced()

Specified by:
monospaced in interface org.apache.maven.doxia.sink.Sink
Overrides:
monospaced in class org.apache.maven.doxia.sink.SinkAdapter

monospaced_

public void monospaced_()

Specified by:
monospaced_ in interface org.apache.maven.doxia.sink.Sink
Overrides:
monospaced_ in class org.apache.maven.doxia.sink.SinkAdapter

lineBreak

public void lineBreak()

Specified by:
lineBreak in interface org.apache.maven.doxia.sink.Sink
Overrides:
lineBreak in class org.apache.maven.doxia.sink.SinkAdapter

nonBreakingSpace

public void nonBreakingSpace()

Specified by:
nonBreakingSpace in interface org.apache.maven.doxia.sink.Sink
Overrides:
nonBreakingSpace in class org.apache.maven.doxia.sink.SinkAdapter

text

public void text(java.lang.String text)

Specified by:
text in interface org.apache.maven.doxia.sink.Sink
Overrides:
text in class org.apache.maven.doxia.sink.SinkAdapter

rawText

public void rawText(java.lang.String text)

Specified by:
rawText in interface org.apache.maven.doxia.sink.Sink
Overrides:
rawText in class org.apache.maven.doxia.sink.SinkAdapter

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.

encodeFragment

public static java.lang.String encodeFragment(java.lang.String text)
Forward to HtmlTools.encodeFragment( text ).

Parameters:
text - the String to fragment, may be null.
Returns:
the fragmented text, null if null String input.
See Also:
HtmlTools.encodeURL(String).

encodeURL

public static java.lang.String encodeURL(java.lang.String text)
Forward to HtmlTools.encodeURL( text ).

Parameters:
text - the String to encode, may be null.
Returns:
the text encoded, null if null String input.
See Also:
HtmlTools.encodeURL(String).

flush

public void flush()

Specified by:
flush in interface org.apache.maven.doxia.sink.Sink
Overrides:
flush in class org.apache.maven.doxia.sink.SinkAdapter

close

public void close()

Specified by:
close in interface org.apache.maven.doxia.sink.Sink
Overrides:
close in class org.apache.maven.doxia.sink.SinkAdapter
Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2002-2010 Apache Software Foundation. All Rights Reserved.