org.deckfour.spex
Class SXCommentNode

java.lang.Object
  extended by org.deckfour.spex.SXNode
      extended by org.deckfour.spex.SXCommentNode

public class SXCommentNode
extends SXNode

Wraps an XML comment within a syntactical node, to allow for correct code formatting / indentation and sufficiently complex document layouts.

Author:
Christian W. Guenther (christian@deckfour.org)

Field Summary
 
Fields inherited from class org.deckfour.spex.SXNode
tabLevel, tabString, writer
 
Constructor Summary
SXCommentNode(String comment, Writer aWriter, int aTabLevel, String aTabString)
          Constructs a new comment node.
 
Method Summary
 void close()
          Explicitly closes this node.
 
Methods inherited from class org.deckfour.spex.SXNode
getTabLevel, indentLine
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SXCommentNode

public SXCommentNode(String comment,
                     Writer aWriter,
                     int aTabLevel,
                     String aTabString)
              throws IOException
Constructs a new comment node.

Parameters:
comment - Comment string, without leading ("<!--") and trailing ("-->") XML-style comment delimiters!
aWriter - output writer
aTabLevel - indentation level
aTabString - tabulator encoding
Throws:
IOException
Method Detail

close

public void close()
           throws IOException
Description copied from class: SXNode
Explicitly closes this node.

Specified by:
close in class SXNode
Throws:
IOException