org.jboss.jdeparser

Class BasicJCommentable

java.lang.Object

org.jboss.jdeparser.BasicJCommentable

All Implemented Interfaces:

JCommentable

Direct Known Subclasses:

AbstractJDocCommentable, BasicJBlock, BasicJStatement, ExpressionJStatement, ImplJLabel, ImplJSourceFile, ImplJSwitch

class BasicJCommentable
extends java.lang.Object
implements JCommentable

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.ArrayList<AbstractJComment>	comments

Constructor Summary

Constructors

Constructor and Description
BasicJCommentable()

Method Summary

Modifier and Type	Method and Description
JComment	blockComment() Add a block comment.
JComment	lineComment() Add a line comment.
(package private) void	writeComments(SourceFileWriter writer)

Methods inherited from class java.lang.Object

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

Field Detail

comments

private java.util.ArrayList<AbstractJComment> comments

Constructor Detail

BasicJCommentable

BasicJCommentable()

Method Detail

lineComment

public JComment lineComment()

Description copied from interface: JCommentable

Add a line comment.

Specified by:

lineComment in interface JCommentable

Returns:

the line comment body

blockComment

public JComment blockComment()

Description copied from interface: JCommentable

Add a block comment.

Specified by:

blockComment in interface JCommentable

Returns:

the block comment body

writeComments

void writeComments(SourceFileWriter writer)
            throws java.io.IOException

Throws:

java.io.IOException