Package net.sourceforge.pmd.lang.java.rule.documentation

Class HeaderCommentsRule

java.lang.Object

net.sourceforge.pmd.properties.AbstractPropertySource

net.sourceforge.pmd.lang.rule.AbstractRule

net.sourceforge.pmd.lang.java.rule.AbstractJavaRule

net.sourceforge.pmd.lang.java.rule.documentation.AbstractCommentRule

net.sourceforge.pmd.lang.java.rule.documentation.HeaderCommentsRule

All Implemented Interfaces:

JavaParserVisitor, net.sourceforge.pmd.lang.rule.ImmutableLanguage, net.sourceforge.pmd.properties.PropertySource, net.sourceforge.pmd.Rule

public class HeaderCommentsRule
extends AbstractCommentRule

Restrictions regarding the legal placement and content of the file header.

Author:

Brian Remedios

Field Summary

Fields

Modifier and Type	Field	Description
static net.sourceforge.pmd.properties.EnumeratedProperty<net.sourceforge.pmd.lang.java.rule.documentation.HeaderCommentsRule.RequiredHeaderPlacement>	HEADER_PLACEMENT_DESCRIPTOR
static net.sourceforge.pmd.properties.StringMultiProperty	REQUIRED_TAGS_DESCRIPTOR
static net.sourceforge.pmd.properties.StringMultiProperty	REQUIRED_TERMS_DESCRIPTOR

Fields inherited from class net.sourceforge.pmd.properties.AbstractPropertySource

propertyDescriptors, propertyValuesByDescriptor

Fields inherited from interface net.sourceforge.pmd.Rule

VIOLATION_SUPPRESS_REGEX_DESCRIPTOR, VIOLATION_SUPPRESS_XPATH_DESCRIPTOR

Constructor Summary

Constructors

Constructor	Description
HeaderCommentsRule()

Method Summary

Modifier and Type	Method	Description
java.lang.Object	visit(ASTCompilationUnit cUnit, java.lang.Object data)

Methods inherited from class net.sourceforge.pmd.lang.java.rule.documentation.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, 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, deepCopy, deepCopyValuesTo, end, equals, getDescription, getExamples, getExternalInfoUrl, getLanguage, getMaximumLanguageVersion, getMessage, getMinimumLanguageVersion, getName, getParserOptions, getPriority, getPropertySourceType, getRuleChainVisits, getRuleClass, getRuleSetName, getSince, hashCode, isDeprecated, isDfa, isMultifile, isRuleChain, isTypeResolution, setDeprecated, setDescription, setDfa, setExternalInfoUrl, setLanguage, setMaximumLanguageVersion, setMessage, setMinimumLanguageVersion, setMultifile, setName, setPriority, setRuleClass, setRuleSetName, setSince, setTypeResolution, setUsesDFA, setUsesMultifile, setUsesTypeResolution, start, usesDFA, usesMultifile, usesRuleChain, usesTypeResolution

Methods inherited from class net.sourceforge.pmd.properties.AbstractPropertySource

copyPropertyDescriptors, copyPropertyValues, definePropertyDescriptor, dysfunctionReason, getOverriddenPropertiesByPropertyDescriptor, getOverriddenPropertyDescriptors, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, ignoredProperties, isPropertyOverridden, setProperty, 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.properties.PropertySource

definePropertyDescriptor, dysfunctionReason, getOverriddenPropertiesByPropertyDescriptor, getOverriddenPropertyDescriptors, getPropertiesByPropertyDescriptor, getProperty, getPropertyDescriptor, getPropertyDescriptors, hasDescriptor, ignoredProperties, isPropertyOverridden, setProperty, setProperty, useDefaultValueFor, usesDefaultValues

Field Detail

REQUIRED_TERMS_DESCRIPTOR

public static final net.sourceforge.pmd.properties.StringMultiProperty REQUIRED_TERMS_DESCRIPTOR

REQUIRED_TAGS_DESCRIPTOR

public static final net.sourceforge.pmd.properties.StringMultiProperty REQUIRED_TAGS_DESCRIPTOR

HEADER_PLACEMENT_DESCRIPTOR

public static final net.sourceforge.pmd.properties.EnumeratedProperty<net.sourceforge.pmd.lang.java.rule.documentation.HeaderCommentsRule.RequiredHeaderPlacement> HEADER_PLACEMENT_DESCRIPTOR

Constructor Detail

HeaderCommentsRule

public HeaderCommentsRule()

Method Detail

visit

public java.lang.Object visit(ASTCompilationUnit cUnit,
                              java.lang.Object data)

Specified by:

visit in interface JavaParserVisitor

Overrides:

visit in class AbstractJavaRule