Interface ASTCommentContainer
-
- All Implemented Interfaces:
-
net.sourceforge.pmd.lang.apex.ast.ApexNode
,net.sourceforge.pmd.lang.ast.Node
,net.sourceforge.pmd.lang.ast.impl.GenericNode
,net.sourceforge.pmd.reporting.Reportable
public interface ASTCommentContainer implements ApexNode<T>
Interface for nodes that can contain comments. Because comments are for the most part lost, the tree builder only captures whether the node did contain comments of any sort in the source code and not the actual contents of those comments. This is useful for rules which need to know whether a node did contain comments.
This information is used for the rule "EmptyCatchBlock", which can ignore empty catch blocks, if they contain comments.
-
-
Method Summary
Modifier and Type Method Description abstract boolean
getContainsComment()
-
Methods inherited from class net.sourceforge.pmd.lang.apex.ast.ApexNode
getDefiningType, getRoot, hasRealLoc
-
Methods inherited from class net.sourceforge.pmd.lang.ast.impl.GenericNode
ancestors, ancestorsOrSelf, asStream, children, descendants, descendantsOrSelf, getChild, getFirstChild, getLastChild, getNextSibling, getParent, getPreviousSibling
-
Methods inherited from class net.sourceforge.pmd.lang.ast.Node
acceptVisitor, ancestors, ancestors, ancestorsOrSelf, asStream, children, children, compareLocation, descendants, descendants, descendantsOrSelf, firstChild, getAstInfo, getBeginColumn, getBeginLine, getChild, getEndColumn, getEndLine, getFirstChild, getImage, getIndexInParent, getLanguageVersion, getLastChild, getNextSibling, getNumChildren, getParent, getPreviousSibling, getReportLocation, getRoot, getTextDocument, getTextRegion, getUserMap, getXPathAttributesIterator, getXPathNodeName, hasImageEqualTo, isFindBoundary
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
getContainsComment
abstract boolean getContainsComment()
-
-
-
-