|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--net.sourceforge.pmd.ast.JavaParserVisitorAdapter | +--net.sourceforge.pmd.AbstractRule
Field Summary |
Fields inherited from interface net.sourceforge.pmd.Rule |
LOWEST_PRIORITY, PRIORITIES |
Constructor Summary | |
AbstractRule()
|
Method Summary | |
void |
addProperty(java.lang.String name,
java.lang.String property)
|
void |
apply(java.util.List acus,
RuleContext ctx)
|
RuleViolation |
createRuleViolation(RuleContext ctx,
int lineNumber)
|
RuleViolation |
createRuleViolation(RuleContext ctx,
int lineNumber,
java.lang.String specificDescription)
|
boolean |
equals(java.lang.Object o)
|
boolean |
getBooleanProperty(java.lang.String name)
|
java.lang.String |
getDescription()
|
double |
getDoubleProperty(java.lang.String name)
|
java.lang.String |
getExample()
|
int |
getIntProperty(java.lang.String name)
|
java.lang.String |
getMessage()
|
java.lang.String |
getName()
|
int |
getPriority()
Returns the rule's priority that is used for including the rule in reports and analysis. |
java.lang.String |
getPriorityName()
Returns the rule's priority name that is used for including the rule in reports and analysis. |
RuleProperties |
getProperties()
Gets an enumeration to enumerate through this rule's property names. |
java.lang.String |
getStringProperty(java.lang.String name)
|
int |
hashCode()
|
boolean |
hasProperty(java.lang.String name)
|
boolean |
include()
When the rule is to be included in the analysis, returns true; otherwise, returns false. |
void |
setDescription(java.lang.String description)
|
void |
setExample(java.lang.String example)
|
void |
setInclude(boolean include)
When the rule is to be included in the analysis, set to true; otherwise, set to false. |
void |
setMessage(java.lang.String message)
|
void |
setName(java.lang.String name)
|
void |
setPriority(int priority)
A rule will specify a priority for inclusion in reports and analysis. |
protected void |
visitAll(java.util.List acus,
RuleContext ctx)
|
Methods inherited from class net.sourceforge.pmd.ast.JavaParserVisitorAdapter |
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 |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public AbstractRule()
Method Detail |
public java.lang.String getDescription()
getDescription
in interface Rule
public void setDescription(java.lang.String description)
setDescription
in interface Rule
public java.lang.String getExample()
getExample
in interface Rule
public void setExample(java.lang.String example)
setExample
in interface Rule
public boolean hasProperty(java.lang.String name)
hasProperty
in interface Rule
public void addProperty(java.lang.String name, java.lang.String property)
addProperty
in interface Rule
public double getDoubleProperty(java.lang.String name)
getDoubleProperty
in interface Rule
public int getIntProperty(java.lang.String name)
getIntProperty
in interface Rule
public boolean getBooleanProperty(java.lang.String name)
getBooleanProperty
in interface Rule
public java.lang.String getStringProperty(java.lang.String name)
getStringProperty
in interface Rule
public java.lang.String getName()
getName
in interface Rule
public void setName(java.lang.String name)
setName
in interface Rule
public java.lang.String getMessage()
getMessage
in interface Rule
public void setMessage(java.lang.String message)
setMessage
in interface Rule
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
protected void visitAll(java.util.List acus, RuleContext ctx)
public void apply(java.util.List acus, RuleContext ctx)
apply
in interface Rule
public RuleViolation createRuleViolation(RuleContext ctx, int lineNumber)
public RuleViolation createRuleViolation(RuleContext ctx, int lineNumber, java.lang.String specificDescription)
public RuleProperties getProperties()
getProperties
in interface Rule
public boolean include()
include
in interface Rule
public void setInclude(boolean include)
setInclude
in interface Rule
include
- True when the rule is included in analysis.public int getPriority()
getPriority
in interface Rule
public java.lang.String getPriorityName()
getPriorityName
in interface Rule
public void setPriority(int priority)
setPriority
in interface Rule
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |