org.codehaus.jam
Interface JComment

All Superinterfaces:
JElement
All Known Subinterfaces:
MComment

public interface JComment
extends JElement

Encapsulates comment associated with a package, class, method, and so on. Although they are often declared in the same place (code comments) JComment is a distinct entity from JAnnotation.

Author:
Patrick Calahan <email: pcal-at-bea-dot-com>

Method Summary
 JSourcePosition getSourcePosition()
          Returns the location of this comment in the source, or null if it is unknown.
 java.lang.String getText()
          Returns the text of this comment.
 
Methods inherited from interface org.codehaus.jam.JElement
accept, getArtifact, getParent, getQualifiedName, getSimpleName, isSourceAvailable, toString
 

Method Detail

getText

java.lang.String getText()
Returns the text of this comment.


getSourcePosition

JSourcePosition getSourcePosition()
Returns the location of this comment in the source, or null if it is unknown.

Specified by:
getSourcePosition in interface JElement