org.apache.maven.aptdoc
Class XdocSink

java.lang.Object
  extended by fr.pixware.apt.parse.SinkAdapter
      extended by org.apache.maven.aptdoc.XdocSink
All Implemented Interfaces:
fr.pixware.apt.parse.Sink

public class XdocSink
extends fr.pixware.apt.parse.SinkAdapter

Sink for aptconvert which generates the maven xml document format. This is very similar to the HTMLSink included with aptconvert.

Version:
$Id: XdocSink.java,v 1.1 2003/04/13 01:25:40 diongillard Exp $
Author:
James Taylor

Field Summary
 
Fields inherited from interface fr.pixware.apt.parse.Sink
NUMBERING_DECIMAL, NUMBERING_LOWER_ALPHA, NUMBERING_LOWER_ROMAN, NUMBERING_UPPER_ALPHA, NUMBERING_UPPER_ROMAN
 
Constructor Summary
XdocSink(java.io.Writer out)
           
 
Method Summary
 void anchor_()
           
 void anchor(java.lang.String name)
           
 void author_()
           
 void body_()
           
 void body()
           
 void bold_()
           
 void bold()
           
protected  void content(java.lang.String text)
           
 void date_()
           
 void definedTerm_()
           
 void definedTerm()
           
 void definition_()
           
 void definition()
           
 void definitionList_()
           
 void definitionList()
           
static java.lang.String encodeFragment(java.lang.String text)
           
static java.lang.String encodeURL(java.lang.String text)
           
static java.lang.String escapeHTML(java.lang.String text)
           
 void head_()
           
 void head()
           
 void horizontalRule()
           
 void italic_()
           
 void italic()
           
 void lineBreak()
           
 void link_()
           
 void link(java.lang.String name)
           
 void list_()
           
 void list()
           
 void listItem_()
           
 void listItem()
           
protected  void markup(java.lang.String text)
           
 void monospaced_()
           
 void monospaced()
           
 void nonBreakingSpace()
           
 void numberedList_()
           
 void numberedList(int numbering)
           
 void numberedListItem_()
           
 void numberedListItem()
           
 void paragraph_()
           
 void paragraph()
           
protected  void resetState()
           
 void section1_()
           
 void section1()
           
 void section2_()
           
 void section2()
           
 void section3_()
           
 void section3()
           
 void section4_()
           
 void section4()
           
 void section5_()
           
 void section5()
           
 void sectionTitle_()
           
 void sectionTitle()
           
 void table_()
           
 void table()
           
 void tableCaption_()
           
 void tableCaption()
           
 void tableCell_()
           
 void tableCell_(boolean headerRow)
           
 void tableCell()
           
 void tableCell(boolean headerRow)
           
 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)
           
 
Methods inherited from class fr.pixware.apt.parse.SinkAdapter
author, date, definitionListItem_, definitionListItem, figure_, figure, figureCaption_, figureCaption, figureGraphics, pageBreak, title
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XdocSink

public XdocSink(java.io.Writer out)
Method Detail

resetState

protected void resetState()

head

public void head()
          throws fr.pixware.apt.parse.ParseException
Specified by:
head in interface fr.pixware.apt.parse.Sink
Overrides:
head in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

head_

public void head_()
           throws fr.pixware.apt.parse.ParseException
Specified by:
head_ in interface fr.pixware.apt.parse.Sink
Overrides:
head_ in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

title_

public void title_()
            throws fr.pixware.apt.parse.ParseException
Specified by:
title_ in interface fr.pixware.apt.parse.Sink
Overrides:
title_ in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

author_

public void author_()
             throws fr.pixware.apt.parse.ParseException
Specified by:
author_ in interface fr.pixware.apt.parse.Sink
Overrides:
author_ in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

date_

public void date_()
           throws fr.pixware.apt.parse.ParseException
Specified by:
date_ in interface fr.pixware.apt.parse.Sink
Overrides:
date_ in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

body

public void body()
          throws fr.pixware.apt.parse.ParseException
Specified by:
body in interface fr.pixware.apt.parse.Sink
Overrides:
body in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

body_

public void body_()
           throws fr.pixware.apt.parse.ParseException
Specified by:
body_ in interface fr.pixware.apt.parse.Sink
Overrides:
body_ in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

section1

public void section1()
              throws fr.pixware.apt.parse.ParseException
Specified by:
section1 in interface fr.pixware.apt.parse.Sink
Overrides:
section1 in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

section2

public void section2()
              throws fr.pixware.apt.parse.ParseException
Specified by:
section2 in interface fr.pixware.apt.parse.Sink
Overrides:
section2 in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

section3

public void section3()
              throws fr.pixware.apt.parse.ParseException
Specified by:
section3 in interface fr.pixware.apt.parse.Sink
Overrides:
section3 in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

section4

public void section4()
              throws fr.pixware.apt.parse.ParseException
Specified by:
section4 in interface fr.pixware.apt.parse.Sink
Overrides:
section4 in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

section5

public void section5()
              throws fr.pixware.apt.parse.ParseException
Specified by:
section5 in interface fr.pixware.apt.parse.Sink
Overrides:
section5 in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

sectionTitle

public void sectionTitle()
                  throws fr.pixware.apt.parse.ParseException
Specified by:
sectionTitle in interface fr.pixware.apt.parse.Sink
Overrides:
sectionTitle in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

sectionTitle_

public void sectionTitle_()
                   throws fr.pixware.apt.parse.ParseException
Specified by:
sectionTitle_ in interface fr.pixware.apt.parse.Sink
Overrides:
sectionTitle_ in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

section1_

public void section1_()
               throws fr.pixware.apt.parse.ParseException
Specified by:
section1_ in interface fr.pixware.apt.parse.Sink
Overrides:
section1_ in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

section2_

public void section2_()
               throws fr.pixware.apt.parse.ParseException
Specified by:
section2_ in interface fr.pixware.apt.parse.Sink
Overrides:
section2_ in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

section3_

public void section3_()
               throws fr.pixware.apt.parse.ParseException
Specified by:
section3_ in interface fr.pixware.apt.parse.Sink
Overrides:
section3_ in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

section4_

public void section4_()
               throws fr.pixware.apt.parse.ParseException
Specified by:
section4_ in interface fr.pixware.apt.parse.Sink
Overrides:
section4_ in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

section5_

public void section5_()
               throws fr.pixware.apt.parse.ParseException
Specified by:
section5_ in interface fr.pixware.apt.parse.Sink
Overrides:
section5_ in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

list

public void list()
          throws fr.pixware.apt.parse.ParseException
Specified by:
list in interface fr.pixware.apt.parse.Sink
Overrides:
list in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

list_

public void list_()
           throws fr.pixware.apt.parse.ParseException
Specified by:
list_ in interface fr.pixware.apt.parse.Sink
Overrides:
list_ in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

listItem

public void listItem()
              throws fr.pixware.apt.parse.ParseException
Specified by:
listItem in interface fr.pixware.apt.parse.Sink
Overrides:
listItem in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

listItem_

public void listItem_()
               throws fr.pixware.apt.parse.ParseException
Specified by:
listItem_ in interface fr.pixware.apt.parse.Sink
Overrides:
listItem_ in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

numberedList

public void numberedList(int numbering)
                  throws fr.pixware.apt.parse.ParseException
Specified by:
numberedList in interface fr.pixware.apt.parse.Sink
Overrides:
numberedList in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

numberedList_

public void numberedList_()
                   throws fr.pixware.apt.parse.ParseException
Specified by:
numberedList_ in interface fr.pixware.apt.parse.Sink
Overrides:
numberedList_ in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

numberedListItem

public void numberedListItem()
                      throws fr.pixware.apt.parse.ParseException
Specified by:
numberedListItem in interface fr.pixware.apt.parse.Sink
Overrides:
numberedListItem in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

numberedListItem_

public void numberedListItem_()
                       throws fr.pixware.apt.parse.ParseException
Specified by:
numberedListItem_ in interface fr.pixware.apt.parse.Sink
Overrides:
numberedListItem_ in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

definitionList

public void definitionList()
                    throws fr.pixware.apt.parse.ParseException
Specified by:
definitionList in interface fr.pixware.apt.parse.Sink
Overrides:
definitionList in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

definitionList_

public void definitionList_()
                     throws fr.pixware.apt.parse.ParseException
Specified by:
definitionList_ in interface fr.pixware.apt.parse.Sink
Overrides:
definitionList_ in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

definedTerm

public void definedTerm()
                 throws fr.pixware.apt.parse.ParseException
Specified by:
definedTerm in interface fr.pixware.apt.parse.Sink
Overrides:
definedTerm in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

definedTerm_

public void definedTerm_()
                  throws fr.pixware.apt.parse.ParseException
Specified by:
definedTerm_ in interface fr.pixware.apt.parse.Sink
Overrides:
definedTerm_ in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

definition

public void definition()
                throws fr.pixware.apt.parse.ParseException
Specified by:
definition in interface fr.pixware.apt.parse.Sink
Overrides:
definition in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

definition_

public void definition_()
                 throws fr.pixware.apt.parse.ParseException
Specified by:
definition_ in interface fr.pixware.apt.parse.Sink
Overrides:
definition_ in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

paragraph

public void paragraph()
               throws fr.pixware.apt.parse.ParseException
Specified by:
paragraph in interface fr.pixware.apt.parse.Sink
Overrides:
paragraph in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

paragraph_

public void paragraph_()
                throws fr.pixware.apt.parse.ParseException
Specified by:
paragraph_ in interface fr.pixware.apt.parse.Sink
Overrides:
paragraph_ in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

verbatim

public void verbatim(boolean boxed)
              throws fr.pixware.apt.parse.ParseException
Specified by:
verbatim in interface fr.pixware.apt.parse.Sink
Overrides:
verbatim in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

verbatim_

public void verbatim_()
               throws fr.pixware.apt.parse.ParseException
Specified by:
verbatim_ in interface fr.pixware.apt.parse.Sink
Overrides:
verbatim_ in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

horizontalRule

public void horizontalRule()
                    throws fr.pixware.apt.parse.ParseException
Specified by:
horizontalRule in interface fr.pixware.apt.parse.Sink
Overrides:
horizontalRule in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

table

public void table()
           throws fr.pixware.apt.parse.ParseException
Specified by:
table in interface fr.pixware.apt.parse.Sink
Overrides:
table in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

table_

public void table_()
            throws fr.pixware.apt.parse.ParseException
Specified by:
table_ in interface fr.pixware.apt.parse.Sink
Overrides:
table_ in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

tableRows

public void tableRows(int[] justification,
                      boolean grid)
               throws fr.pixware.apt.parse.ParseException
Specified by:
tableRows in interface fr.pixware.apt.parse.Sink
Overrides:
tableRows in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

tableRows_

public void tableRows_()
                throws fr.pixware.apt.parse.ParseException
Specified by:
tableRows_ in interface fr.pixware.apt.parse.Sink
Overrides:
tableRows_ in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

tableRow

public void tableRow()
              throws fr.pixware.apt.parse.ParseException
Specified by:
tableRow in interface fr.pixware.apt.parse.Sink
Overrides:
tableRow in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

tableRow_

public void tableRow_()
               throws fr.pixware.apt.parse.ParseException
Specified by:
tableRow_ in interface fr.pixware.apt.parse.Sink
Overrides:
tableRow_ in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

tableCell

public void tableCell()
               throws fr.pixware.apt.parse.ParseException
Specified by:
tableCell in interface fr.pixware.apt.parse.Sink
Overrides:
tableCell in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

tableHeaderCell

public void tableHeaderCell()
                     throws fr.pixware.apt.parse.ParseException
Throws:
fr.pixware.apt.parse.ParseException

tableCell

public void tableCell(boolean headerRow)
               throws fr.pixware.apt.parse.ParseException
Throws:
fr.pixware.apt.parse.ParseException

tableCell_

public void tableCell_()
                throws fr.pixware.apt.parse.ParseException
Specified by:
tableCell_ in interface fr.pixware.apt.parse.Sink
Overrides:
tableCell_ in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

tableHeaderCell_

public void tableHeaderCell_()
                      throws fr.pixware.apt.parse.ParseException
Throws:
fr.pixware.apt.parse.ParseException

tableCell_

public void tableCell_(boolean headerRow)
                throws fr.pixware.apt.parse.ParseException
Throws:
fr.pixware.apt.parse.ParseException

tableCaption

public void tableCaption()
                  throws fr.pixware.apt.parse.ParseException
Specified by:
tableCaption in interface fr.pixware.apt.parse.Sink
Overrides:
tableCaption in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

tableCaption_

public void tableCaption_()
                   throws fr.pixware.apt.parse.ParseException
Specified by:
tableCaption_ in interface fr.pixware.apt.parse.Sink
Overrides:
tableCaption_ in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

anchor

public void anchor(java.lang.String name)
            throws fr.pixware.apt.parse.ParseException
Specified by:
anchor in interface fr.pixware.apt.parse.Sink
Overrides:
anchor in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

anchor_

public void anchor_()
             throws fr.pixware.apt.parse.ParseException
Specified by:
anchor_ in interface fr.pixware.apt.parse.Sink
Overrides:
anchor_ in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

link

public void link(java.lang.String name)
          throws fr.pixware.apt.parse.ParseException
Specified by:
link in interface fr.pixware.apt.parse.Sink
Overrides:
link in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

link_

public void link_()
           throws fr.pixware.apt.parse.ParseException
Specified by:
link_ in interface fr.pixware.apt.parse.Sink
Overrides:
link_ in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

italic

public void italic()
            throws fr.pixware.apt.parse.ParseException
Specified by:
italic in interface fr.pixware.apt.parse.Sink
Overrides:
italic in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

italic_

public void italic_()
             throws fr.pixware.apt.parse.ParseException
Specified by:
italic_ in interface fr.pixware.apt.parse.Sink
Overrides:
italic_ in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

bold

public void bold()
          throws fr.pixware.apt.parse.ParseException
Specified by:
bold in interface fr.pixware.apt.parse.Sink
Overrides:
bold in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

bold_

public void bold_()
           throws fr.pixware.apt.parse.ParseException
Specified by:
bold_ in interface fr.pixware.apt.parse.Sink
Overrides:
bold_ in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

monospaced

public void monospaced()
                throws fr.pixware.apt.parse.ParseException
Specified by:
monospaced in interface fr.pixware.apt.parse.Sink
Overrides:
monospaced in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

monospaced_

public void monospaced_()
                 throws fr.pixware.apt.parse.ParseException
Specified by:
monospaced_ in interface fr.pixware.apt.parse.Sink
Overrides:
monospaced_ in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

lineBreak

public void lineBreak()
               throws fr.pixware.apt.parse.ParseException
Specified by:
lineBreak in interface fr.pixware.apt.parse.Sink
Overrides:
lineBreak in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

nonBreakingSpace

public void nonBreakingSpace()
                      throws fr.pixware.apt.parse.ParseException
Specified by:
nonBreakingSpace in interface fr.pixware.apt.parse.Sink
Overrides:
nonBreakingSpace in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

text

public void text(java.lang.String text)
          throws fr.pixware.apt.parse.ParseException
Specified by:
text in interface fr.pixware.apt.parse.Sink
Overrides:
text in class fr.pixware.apt.parse.SinkAdapter
Throws:
fr.pixware.apt.parse.ParseException

markup

protected void markup(java.lang.String text)
               throws fr.pixware.apt.parse.ParseException
Throws:
fr.pixware.apt.parse.ParseException

content

protected void content(java.lang.String text)
                throws fr.pixware.apt.parse.ParseException
Throws:
fr.pixware.apt.parse.ParseException

verbatimContent

protected void verbatimContent(java.lang.String text)
                        throws fr.pixware.apt.parse.ParseException
Throws:
fr.pixware.apt.parse.ParseException

escapeHTML

public static java.lang.String escapeHTML(java.lang.String text)

encodeFragment

public static java.lang.String encodeFragment(java.lang.String text)

encodeURL

public static java.lang.String encodeURL(java.lang.String text)


Copyright © 2003-2011 SourceForge. All Rights Reserved.