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.xdoc
Class XdocSink

java.lang.Object
  extended byorg.apache.maven.doxia.sink.SinkAdapter
      extended byorg.apache.maven.doxia.sink.AbstractXmlSink
          extended byorg.apache.maven.doxia.module.xdoc.XdocSink
All Implemented Interfaces:
org.apache.maven.doxia.markup.Markup, org.apache.maven.doxia.sink.Sink, XdocMarkup, org.apache.maven.doxia.markup.XmlMarkup
public class XdocSink
extends org.apache.maven.doxia.sink.AbstractXmlSink
implements XdocMarkup

A doxia Sink which produces an xdoc model.

Since:
1.0
Version:
$Id: XdocSink.java 599204 2007-11-28 23:49:33Z hboutemy $
Author:
James Taylor

Field Summary
protected  StringBuffer buffer
          Used to collect text events.
protected  boolean headFlag
          An indication on if we're inside a head.
protected  org.apache.maven.doxia.util.LineBreaker out
          The LineBreaker to write the result.
protected  boolean titleFlag
          An indication on if we're inside a title.
 
Fields inherited from interface org.apache.maven.doxia.module.xdoc.XdocMarkup
AUTHOR_TAG, DATE_TAG, DOCUMENT_TAG, MACRO_TAG, PROPERTIES_TAG, SECTION_TAG, SOURCE_TAG, SUBSECTION_TAG
 
Fields inherited from interface org.apache.maven.doxia.markup.XmlMarkup
BANG, CDATA
 
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
XdocSink(Writer writer)
          Constructor, initialize the LineBreaker.
 
Method Summary
 void anchor_()
          
 void anchor(String name)
          
 void author_()
          
 void body_()
          
 void body()
          
 void bold_()
          
 void bold()
          
 void close()
          
protected  void content(String text)
          Write HTML escaped text to output, not preserving white space.
 void date_()
          
 void definedTerm_()
          
 void definedTerm()
          
 void definition_()
          
 void definition()
          
 void definitionList_()
          
 void definitionList()
          
static String encodeURL(String text)
          Forward to HtmlTools.encodeURL( text ).
static String escapeHTML(String text)
          Forward to HtmlTools.escapeHTML( text ).
 void figure_()
          
 void figure()
          
 void figureCaption_()
          
 void figureCaption()
          
 void figureGraphics(String s)
          
 void flush()
          
 void head_()
          
 void head()
          
 void horizontalRule()
          
 void italic_()
          
 void italic()
          
 void lineBreak()
          
 void link_()
          
 void link(String name)
          
 void list_()
          
 void list()
          
 void listItem_()
          
 void listItem()
          
protected  void markup(String text)
          Write text to output, preserving white space.
 void monospaced_()
          
 void monospaced()
          
 void nonBreakingSpace()
          
 void numberedList_()
          
 void numberedList(int numbering)
          The default list style depends on the numbering.
 void numberedListItem_()
          
 void numberedListItem()
          
 void paragraph_()
          
 void paragraph()
          
protected  void resetState()
          Reset all variables.
 void section1_()
          
 void section1()
          
 void section2_()
          
 void section2()
          
 void section3_()
          
 void section3()
          
 void section4_()
          
 void section4()
          
 void section5_()
          
 void section5()
          
 void sectionTitle1_()
          
 void sectionTitle1()
          
 void sectionTitle2_()
          
 void sectionTitle2()
          
 void sectionTitle3_()
          
 void sectionTitle3()
          
 void sectionTitle4_()
          
 void sectionTitle4()
          
 void sectionTitle5_()
          
 void sectionTitle5()
          
 void table_()
          
 void table()
          The default align is center.
 void tableCaption_()
          
 void tableCaption()
          
 void tableCell_()
          
 void tableCell_(boolean headerRow)
          Ends a table cell.
 void tableCell()
          
 void tableCell(boolean headerRow)
          Starts a table cell.
 void tableHeaderCell_()
          
 void tableHeaderCell()
          
 void tableRow_()
          
 void tableRow()
          The default valign is top.
 void tableRows_()
          
 void tableRows(int[] justification, boolean grid)
          The default align is center.
 void text(String text)
          
 void title_()
          
 void verbatim_()
          
 void verbatim(boolean boxed)
          
protected  void verbatimContent(String text)
          Write HTML escaped text to output, preserving white space.
protected  void write(String text)
          
 
Methods inherited from class org.apache.maven.doxia.sink.AbstractXmlSink
writeEndTag, writeEndTagWithoutEOL, writeSimpleTag, writeSimpleTag, writeStartTag, writeStartTag, writeStartTag
 
Methods inherited from class org.apache.maven.doxia.sink.SinkAdapter
author, date, definitionListItem_, definitionListItem, pageBreak, rawText, sectionTitle_, sectionTitle, tableCell, tableHeaderCell, title
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

out

protected org.apache.maven.doxia.util.LineBreaker out
The LineBreaker to write the result.

buffer

protected StringBuffer buffer
Used to collect text events.

headFlag

protected boolean headFlag
An indication on if we're inside a head.

titleFlag

protected boolean titleFlag
An indication on if we're inside a title. This will prevent the styling of titles.

Constructor Detail

XdocSink

public XdocSink(Writer writer)
Constructor, initialize the LineBreaker.

Parameters:
writer - The writer to write the result.
Method Detail

resetState

protected void resetState()
Reset all variables.

head

public void head()

Specified by:
head in interface org.apache.maven.doxia.sink.Sink
See Also:
XdocMarkup.DOCUMENT_TAG, XdocMarkup.PROPERTIES_TAG

head_

public void head_()

Specified by:
head_ in interface org.apache.maven.doxia.sink.Sink
See Also:
XdocMarkup.DOCUMENT_TAG, XdocMarkup.PROPERTIES_TAG

title_

public void title_()

Specified by:
title_ in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.TITLE

author_

public void author_()

Specified by:
author_ in interface org.apache.maven.doxia.sink.Sink
See Also:
XdocMarkup.AUTHOR_TAG

date_

public void date_()

Specified by:
date_ in interface org.apache.maven.doxia.sink.Sink
See Also:
XdocMarkup.DATE_TAG

body

public void body()

Specified by:
body in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.BODY

body_

public void body_()

Specified by:
body_ in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.BODY, XdocMarkup.DOCUMENT_TAG

section1

public void section1()

Specified by:
section1 in interface org.apache.maven.doxia.sink.Sink

sectionTitle1

public void sectionTitle1()

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

sectionTitle1_

public void sectionTitle1_()

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

section1_

public void section1_()

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

section2

public void section2()

Specified by:
section2 in interface org.apache.maven.doxia.sink.Sink

sectionTitle2

public void sectionTitle2()

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

sectionTitle2_

public void sectionTitle2_()

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

section2_

public void section2_()

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

section3

public void section3()

Specified by:
section3 in interface org.apache.maven.doxia.sink.Sink

sectionTitle3

public void sectionTitle3()

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

sectionTitle3_

public void sectionTitle3_()

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

section3_

public void section3_()

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

section4

public void section4()

Specified by:
section4 in interface org.apache.maven.doxia.sink.Sink

sectionTitle4

public void sectionTitle4()

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

sectionTitle4_

public void sectionTitle4_()

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

section4_

public void section4_()

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

section5

public void section5()

Specified by:
section5 in interface org.apache.maven.doxia.sink.Sink

sectionTitle5

public void sectionTitle5()

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

sectionTitle5_

public void sectionTitle5_()

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

section5_

public void section5_()

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

list

public void list()

Specified by:
list in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.UL

list_

public void list_()

Specified by:
list_ in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.UL

listItem

public void listItem()

Specified by:
listItem in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.LI

listItem_

public void listItem_()

Specified by:
listItem_ in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.LI

numberedList

public void numberedList(int numbering)
The default list style depends on the numbering.

Specified by:
numberedList in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.OL

numberedList_

public void numberedList_()

Specified by:
numberedList_ in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.OL

numberedListItem

public void numberedListItem()

Specified by:
numberedListItem in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.LI

numberedListItem_

public void numberedListItem_()

Specified by:
numberedListItem_ in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.LI

definitionList

public void definitionList()

Specified by:
definitionList in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.DL

definitionList_

public void definitionList_()

Specified by:
definitionList_ in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.DL

definedTerm

public void definedTerm()

Specified by:
definedTerm in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.DT

definedTerm_

public void definedTerm_()

Specified by:
definedTerm_ in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.DT

definition

public void definition()

Specified by:
definition in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.DD

definition_

public void definition_()

Specified by:
definition_ in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.DD

figure

public void figure()

Specified by:
figure in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.IMG

figure_

public void figure_()

Specified by:
figure_ in interface org.apache.maven.doxia.sink.Sink

figureGraphics

public void figureGraphics(String s)

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

figureCaption

public void figureCaption()

Specified by:
figureCaption in interface org.apache.maven.doxia.sink.Sink

figureCaption_

public void figureCaption_()

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

paragraph

public void paragraph()

Specified by:
paragraph in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.P

paragraph_

public void paragraph_()

Specified by:
paragraph_ in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.P

verbatim

public void verbatim(boolean boxed)

Specified by:
verbatim in interface org.apache.maven.doxia.sink.Sink
See Also:
XdocMarkup.SOURCE_TAG, HTML.Tag.PRE

verbatim_

public void verbatim_()

Specified by:
verbatim_ in interface org.apache.maven.doxia.sink.Sink
See Also:
XdocMarkup.SOURCE_TAG, HTML.Tag.PRE

horizontalRule

public void horizontalRule()

Specified by:
horizontalRule in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.HR

table

public void table()
The default align is center.

Specified by:
table in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.TABLE

table_

public void table_()

Specified by:
table_ in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.TABLE

tableRows

public void tableRows(int[] justification,
                      boolean grid)
The default align is center.

Specified by:
tableRows in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.TABLE

tableRows_

public void tableRows_()

Specified by:
tableRows_ in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.TABLE

tableRow

public void tableRow()
The default valign is top.

Specified by:
tableRow in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.TR

tableRow_

public void tableRow_()

Specified by:
tableRow_ in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.TR

tableCell

public void tableCell()

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

tableHeaderCell

public void tableHeaderCell()

Specified by:
tableHeaderCell in interface org.apache.maven.doxia.sink.Sink

tableCell

public void tableCell(boolean headerRow)
Starts a table cell.

Parameters:
headerRow - true if it is an header row
See Also:
HTML.Tag.TH, HTML.Tag.TD

tableCell_

public void tableCell_()

Specified by:
tableCell_ in interface org.apache.maven.doxia.sink.Sink

tableHeaderCell_

public void tableHeaderCell_()

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

tableCell_

public void tableCell_(boolean headerRow)
Ends a table cell.

Parameters:
headerRow - true if it is an header row
See Also:
HTML.Tag.TH, HTML.Tag.TD

tableCaption

public void tableCaption()

Specified by:
tableCaption in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.P, HTML.Tag.I

tableCaption_

public void tableCaption_()

Specified by:
tableCaption_ in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.P, HTML.Tag.I

anchor

public void anchor(String name)

Specified by:
anchor in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.A

anchor_

public void anchor_()

Specified by:
anchor_ in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.A

link

public void link(String name)

Specified by:
link in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.A

link_

public void link_()

Specified by:
link_ in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.A

italic

public void italic()

Specified by:
italic in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.I

italic_

public void italic_()

Specified by:
italic_ in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.I

bold

public void bold()

Specified by:
bold in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.B

bold_

public void bold_()

Specified by:
bold_ in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.B

monospaced

public void monospaced()

Specified by:
monospaced in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.TT

monospaced_

public void monospaced_()

Specified by:
monospaced_ in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.TT

lineBreak

public void lineBreak()

Specified by:
lineBreak in interface org.apache.maven.doxia.sink.Sink
See Also:
HTML.Tag.BR

nonBreakingSpace

public void nonBreakingSpace()

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

text

public void text(String text)

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

markup

protected void markup(String text)
Write text to output, preserving white space.

Parameters:
text - The text to write.

content

protected void content(String text)
Write HTML escaped text to output, not preserving white space.

Parameters:
text - The text to write.

verbatimContent

protected void verbatimContent(String text)
Write HTML escaped text to output, preserving white space.

Parameters:
text - The text to write.

escapeHTML

public static String escapeHTML(String text)
Forward to HtmlTools.escapeHTML( text ).

Parameters:
text - the String to escape, may be null
Returns:
the text escaped, "" if null String input
See Also:
HtmlTools.escapeHTML(String)

encodeURL

public static String encodeURL(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

close

public void close()

Specified by:
close in interface org.apache.maven.doxia.sink.Sink

write

protected void write(String text)

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-2008 The Apache Software Foundation. All Rights Reserved.