net.sourceforge.pmd.lang.java.rule.comments
Class CommentRequiredRule

java.lang.Object
  net.sourceforge.pmd.AbstractPropertySource
      net.sourceforge.pmd.lang.rule.AbstractRule
          net.sourceforge.pmd.lang.java.rule.AbstractJavaRule
              net.sourceforge.pmd.lang.java.rule.comments.AbstractCommentRule
                  net.sourceforge.pmd.lang.java.rule.comments.CommentRequiredRule

All Implemented Interfaces:

JavaParserVisitor, ImmutableLanguage, PropertySource, Rule

public class CommentRequiredRule
extends AbstractCommentRule

Author:

Brian Remedios

Field Summary

static EnumeratedProperty<net.sourceforge.pmd.lang.java.rule.comments.CommentRequiredRule.CommentRequirement>	ENUM_CMT_REQUIREMENT_DESCRIPTOR
static EnumeratedProperty<net.sourceforge.pmd.lang.java.rule.comments.CommentRequiredRule.CommentRequirement>	FIELD_CMT_REQUIREMENT_DESCRIPTOR
static EnumeratedProperty<net.sourceforge.pmd.lang.java.rule.comments.CommentRequiredRule.CommentRequirement>	HEADER_CMT_REQUIREMENT_DESCRIPTOR
static EnumeratedProperty<net.sourceforge.pmd.lang.java.rule.comments.CommentRequiredRule.CommentRequirement>	PROT_METHOD_CMT_REQUIREMENT_DESCRIPTOR
static EnumeratedProperty<net.sourceforge.pmd.lang.java.rule.comments.CommentRequiredRule.CommentRequirement>	PUB_METHOD_CMT_REQUIREMENT_DESCRIPTOR

Fields inherited from class net.sourceforge.pmd.AbstractPropertySource

propertyDescriptors, propertyValuesByDescriptor

Fields inherited from interface net.sourceforge.pmd.Rule

VIOLATION_SUPPRESS_REGEX_DESCRIPTOR, VIOLATION_SUPPRESS_XPATH_DESCRIPTOR

Constructor Summary

CommentRequiredRule()

Method Summary

boolean	allCommentsAreIgnored()
String	dysfunctionReason()
Object	visit(ASTClassOrInterfaceDeclaration decl, Object data)
Object	visit(ASTCompilationUnit cUnit, Object data)
Object	visit(ASTConstructorDeclaration decl, Object data)
Object	visit(ASTEnumDeclaration decl, Object data)
Object	visit(ASTFieldDeclaration decl, Object data)
Object	visit(ASTMethodDeclaration decl, Object data)

Methods inherited from class net.sourceforge.pmd.lang.java.rule.comments.AbstractCommentRule

assignCommentsToDeclarations, filteredCommentIn, orderedCommentsAndDeclarations, tagsIndicesIn

Methods inherited from class net.sourceforge.pmd.lang.java.rule.AbstractJavaRule

apply, getDeclaringType, importsPackage, isQualifiedName, isSuppressed, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visit, visitAll

Methods inherited from class net.sourceforge.pmd.lang.rule.AbstractRule

addExample, addRuleChainVisit, addRuleChainVisit, addViolation, addViolation, addViolation, addViolationWithMessage, addViolationWithMessage, addViolationWithMessage, deepCopyValuesTo, end, equals, getDescription, getExamples, getExternalInfoUrl, getLanguage, getMaximumLanguageVersion, getMessage, getMinimumLanguageVersion, getName, getParserOptions, getPriority, getRuleChainVisits, getRuleClass, getRuleSetName, getSince, hashCode, isDeprecated, setDeprecated, setDescription, setExternalInfoUrl, setLanguage, setMaximumLanguageVersion, setMessage, setMinimumLanguageVersion, setName, setPriority, setRuleClass, setRuleSetName, setSince, setUsesDFA, setUsesTypeResolution, start, usesDFA, usesRuleChain, usesTypeResolution

Methods inherited from class net.sourceforge.pmd.AbstractPropertySource

copyPropertyDescriptors, copyPropertyValues, definePropertyDescriptor, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, ignoredProperties, setProperty, useDefaultValueFor, usesDefaultValues

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sourceforge.pmd.PropertySource

definePropertyDescriptor, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, ignoredProperties, setProperty, useDefaultValueFor, usesDefaultValues

Field Detail

HEADER_CMT_REQUIREMENT_DESCRIPTOR

public static final EnumeratedProperty<net.sourceforge.pmd.lang.java.rule.comments.CommentRequiredRule.CommentRequirement> HEADER_CMT_REQUIREMENT_DESCRIPTOR

FIELD_CMT_REQUIREMENT_DESCRIPTOR

public static final EnumeratedProperty<net.sourceforge.pmd.lang.java.rule.comments.CommentRequiredRule.CommentRequirement> FIELD_CMT_REQUIREMENT_DESCRIPTOR

PUB_METHOD_CMT_REQUIREMENT_DESCRIPTOR

public static final EnumeratedProperty<net.sourceforge.pmd.lang.java.rule.comments.CommentRequiredRule.CommentRequirement> PUB_METHOD_CMT_REQUIREMENT_DESCRIPTOR

PROT_METHOD_CMT_REQUIREMENT_DESCRIPTOR

public static final EnumeratedProperty<net.sourceforge.pmd.lang.java.rule.comments.CommentRequiredRule.CommentRequirement> PROT_METHOD_CMT_REQUIREMENT_DESCRIPTOR

ENUM_CMT_REQUIREMENT_DESCRIPTOR

public static final EnumeratedProperty<net.sourceforge.pmd.lang.java.rule.comments.CommentRequiredRule.CommentRequirement> ENUM_CMT_REQUIREMENT_DESCRIPTOR

Constructor Detail

CommentRequiredRule

public CommentRequiredRule()

Method Detail

visit

public Object visit(ASTClassOrInterfaceDeclaration decl,
                    Object data)

Specified by:

visit in interface JavaParserVisitor

Overrides:

visit in class AbstractJavaRule

visit

public Object visit(ASTConstructorDeclaration decl,
                    Object data)

Specified by:

visit in interface JavaParserVisitor

Overrides:

visit in class AbstractJavaRule

visit

public Object visit(ASTMethodDeclaration decl,
                    Object data)

Specified by:

visit in interface JavaParserVisitor

Overrides:

visit in class AbstractJavaRule

visit

public Object visit(ASTFieldDeclaration decl,
                    Object data)

Specified by:

visit in interface JavaParserVisitor

Overrides:

visit in class AbstractJavaRule

visit

public Object visit(ASTEnumDeclaration decl,
                    Object data)

Specified by:

visit in interface JavaParserVisitor

Overrides:

visit in class AbstractJavaRule

visit

public Object visit(ASTCompilationUnit cUnit,
                    Object data)

Specified by:

visit in interface JavaParserVisitor

Overrides:

visit in class AbstractJavaRule

allCommentsAreIgnored

public boolean allCommentsAreIgnored()

dysfunctionReason

public String dysfunctionReason()

Specified by:

dysfunctionReason in interface PropertySource

Overrides:

dysfunctionReason in class AbstractPropertySource

See Also:

PropertySource.dysfunctionReason()