ca.quine.jcommons.sourcegen
Class BlockTagSource

java.lang.Object
  |
  +--ca.quine.jcommons.sourcegen.BlockTagSource

Direct Known Subclasses:

SecondColumnBlockTagSource

public class BlockTagSource

extends Object

Represents any JavaDoc block tag that has a name and associated text, but no second column. For example, "@return" or "@see".

See Also:

SecondColumnBlockTagSource

Constructor Summary

BlockTagSource(String name)

Method Summary

int	getFirstColumn()
String	getName()
JavaDocCommentSource	getParent()
int	getSecondColumn()
String	getText()
void	output(FormattingRules rules, StringBuffer buffer, int firstColumn, int secondColumn)
protected void	outputText(FormattingRules rules, StringBuffer buffer, int secondColumn, StringBuffer firstLinePrefix)
void	setName(String name)
void	setParent(JavaDocCommentSource parent)
void	setText(String text)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BlockTagSource

public BlockTagSource(String name)

Method Detail

getParent

public JavaDocCommentSource getParent()

setParent

public void setParent(JavaDocCommentSource parent)

getName

public String getName()

setName

public void setName(String name)

getText

public String getText()

setText

public void setText(String text)

getFirstColumn

public int getFirstColumn()

getSecondColumn

public int getSecondColumn()

output

public void output(FormattingRules rules,
                   StringBuffer buffer,
                   int firstColumn,
                   int secondColumn)

outputText

protected void outputText(FormattingRules rules,
                          StringBuffer buffer,
                          int secondColumn,
                          StringBuffer firstLinePrefix)