org.apache.maven.doxia.sink
Class AbstractXmlSink

java.lang.Object
  extended by org.apache.maven.doxia.sink.SinkAdapter
      extended by org.apache.maven.doxia.sink.AbstractXmlSink
All Implemented Interfaces:
Markup, XmlMarkup, Sink
Direct Known Subclasses:
DocBookSink, XdocSink, XhtmlSink

public abstract class AbstractXmlSink
extends SinkAdapter
implements XmlMarkup

An abstract Sink for xml markup syntax.

Since:
1.0
Version:
$Id: AbstractXmlSink.java 599204 2007-11-28 23:49:33Z hboutemy $
Author:
Vincent Siveton

Field Summary
 
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
AbstractXmlSink()
           
 
Method Summary
protected abstract  void write(String text)
          TODO DOXIA-59 Need to uniform writing
protected  void writeEndTag(HTML.Tag t)
          Ends a Tag followed by an EOL.
protected  void writeEndTagWithoutEOL(HTML.Tag t)
          Ends a Tag without an EOL.
protected  void writeSimpleTag(HTML.Tag t)
          Starts a simple Tag.
protected  void writeSimpleTag(HTML.Tag t, MutableAttributeSet att)
          Starts a simple Tag with attributes.
protected  void writeStartTag(HTML.Tag t)
          Starts a Tag.
protected  void writeStartTag(HTML.Tag t, MutableAttributeSet att)
          Starts a Tag with attributes.
protected  void writeStartTag(HTML.Tag t, MutableAttributeSet att, boolean isSimpleTag)
          Starts a Tag with attributes.
 
Methods inherited from class org.apache.maven.doxia.sink.SinkAdapter
anchor_, anchor, author_, author, body_, body, bold_, bold, close, date_, date, definedTerm_, definedTerm, definition_, definition, definitionList_, definitionList, definitionListItem_, definitionListItem, figure_, figure, figureCaption_, figureCaption, figureGraphics, flush, head_, head, horizontalRule, italic_, italic, lineBreak, link_, link, list_, list, listItem_, listItem, monospaced_, monospaced, nonBreakingSpace, numberedList_, numberedList, numberedListItem_, numberedListItem, pageBreak, paragraph_, paragraph, rawText, section1_, section1, section2_, section2, section3_, section3, section4_, section4, section5_, section5, sectionTitle_, sectionTitle, sectionTitle1_, sectionTitle1, sectionTitle2_, sectionTitle2, sectionTitle3_, sectionTitle3, sectionTitle4_, sectionTitle4, sectionTitle5_, sectionTitle5, table_, table, tableCaption_, tableCaption, tableCell_, tableCell, tableCell, tableHeaderCell_, tableHeaderCell, tableHeaderCell, tableRow_, tableRow, tableRows_, tableRows, text, title_, title, verbatim_, verbatim
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AbstractXmlSink

public AbstractXmlSink()
Method Detail

writeStartTag

protected void writeStartTag(HTML.Tag t)
Starts a Tag. For instance:
 <tag>
 

Parameters:
t - a non null tag
See Also:
writeStartTag(javax.swing.text.html.HTML.Tag, javax.swing.text.MutableAttributeSet)

writeStartTag

protected void writeStartTag(HTML.Tag t,
                             MutableAttributeSet att)
Starts a Tag with attributes. For instance:
 <tag attName="attValue">
 

Parameters:
t - a non null tag
att - a set of attributes
See Also:
writeStartTag(javax.swing.text.html.HTML.Tag, javax.swing.text.MutableAttributeSet, boolean)

writeStartTag

protected void writeStartTag(HTML.Tag t,
                             MutableAttributeSet att,
                             boolean isSimpleTag)
Starts a Tag with attributes. For instance:
 <tag attName="attValue">
 

Parameters:
t - a non null tag
att - a set of attributes
isSimpleTag - boolean to write as a simple tag

writeEndTag

protected void writeEndTag(HTML.Tag t)
Ends a Tag followed by an EOL. For instance:
</tag>
 

Parameters:
t - a tag

writeEndTagWithoutEOL

protected void writeEndTagWithoutEOL(HTML.Tag t)
Ends a Tag without an EOL. For instance:
</tag>

Parameters:
t - a tag

writeSimpleTag

protected void writeSimpleTag(HTML.Tag t)
Starts a simple Tag. For instance:
 <tag />
 

Parameters:
t - a non null tag
See Also:
writeSimpleTag(javax.swing.text.html.HTML.Tag, javax.swing.text.MutableAttributeSet)

writeSimpleTag

protected void writeSimpleTag(HTML.Tag t,
                              MutableAttributeSet att)
Starts a simple Tag with attributes. For instance:
 <tag attName="attValue" />
 

Parameters:
t - a non null tag
att - a set of attributes
See Also:
writeStartTag(javax.swing.text.html.HTML.Tag, javax.swing.text.MutableAttributeSet, boolean)

write

protected abstract void write(String text)
TODO DOXIA-59 Need to uniform writing

Parameters:
text - the given text to write


Copyright © 2005-2011 Apache Software Foundation. All Rights Reserved.