|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectnet.sourceforge.pmd.AbstractDelegateRule
net.sourceforge.pmd.RuleReference
public class RuleReference
This class represents a Rule which is a reference to Rule defined in another RuleSet. All details of the Rule are delegated to the underlying referenced Rule, but those operations which modify overridden aspects of the rule are explicitly tracked. Modification operations which set a value to the current underlying value do not override.
| Field Summary |
|---|
| Fields inherited from interface net.sourceforge.pmd.Rule |
|---|
LOWEST_PRIORITY, PRIORITIES |
| Constructor Summary | |
|---|---|
RuleReference()
|
|
| Method Summary | |
|---|---|
void |
addExample(java.lang.String example)
Add a single example for this Rule. |
void |
addProperties(java.util.Properties properties)
Add a set of properties to this Rule. |
void |
addProperty(java.lang.String name,
java.lang.String property)
Add a specific property to this Rule. |
java.lang.String |
getOverriddenDescription()
|
java.util.List<java.lang.String> |
getOverriddenExamples()
|
java.lang.String |
getOverriddenExternalInfoUrl()
|
java.lang.String |
getOverriddenMessage()
|
java.lang.String |
getOverriddenName()
|
java.lang.Integer |
getOverriddenPriority()
|
java.util.Properties |
getOverriddenProperties()
|
RuleSetReference |
getRuleSetReference()
|
void |
setDescription(java.lang.String description)
Set the description of this Rule. |
void |
setExternalInfoUrl(java.lang.String externalInfoUrl)
Set a URL for external information about this Rule. |
void |
setMessage(java.lang.String message)
Set the message to show when this Rule identifies a violation. |
void |
setName(java.lang.String name)
Set the name of this Rule. |
void |
setPriority(int priority)
Set the priority of this Rule. |
void |
setRuleSetReference(RuleSetReference ruleSetReference)
|
| Methods inherited from class net.sourceforge.pmd.AbstractDelegateRule |
|---|
addRuleChainVisit, apply, end, getBooleanProperty, getDescription, getDoubleProperty, getExample, getExamples, getExternalInfoUrl, getIntProperty, getMessage, getName, getPriority, getPriorityName, getProperties, getRule, getRuleChainVisits, getRuleClass, getRuleSetName, getSince, getStringProperty, hasProperty, include, propertyDescriptorFor, setInclude, setRule, setRuleClass, setRuleSetName, setSince, setUsesDFA, setUsesTypeResolution, start, usesDFA, usesRuleChain, usesTypeResolution |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public RuleReference()
| Method Detail |
|---|
public java.lang.String getOverriddenName()
public void setName(java.lang.String name)
Rule
setName in interface RulesetName in class AbstractDelegateRulepublic java.util.Properties getOverriddenProperties()
public void addProperty(java.lang.String name,
java.lang.String property)
Rule
addProperty in interface RuleaddProperty in class AbstractDelegateRulepublic void addProperties(java.util.Properties properties)
Rule
addProperties in interface RuleaddProperties in class AbstractDelegateRulepublic java.lang.String getOverriddenMessage()
public void setMessage(java.lang.String message)
Rule
setMessage in interface RulesetMessage in class AbstractDelegateRulepublic java.lang.String getOverriddenDescription()
public void setDescription(java.lang.String description)
Rule
setDescription in interface RulesetDescription in class AbstractDelegateRulepublic java.util.List<java.lang.String> getOverriddenExamples()
public void addExample(java.lang.String example)
Rule
addExample in interface RuleaddExample in class AbstractDelegateRulepublic java.lang.String getOverriddenExternalInfoUrl()
public void setExternalInfoUrl(java.lang.String externalInfoUrl)
Rule
setExternalInfoUrl in interface RulesetExternalInfoUrl in class AbstractDelegateRulepublic java.lang.Integer getOverriddenPriority()
public void setPriority(int priority)
Rule
setPriority in interface RulesetPriority in class AbstractDelegateRulepublic RuleSetReference getRuleSetReference()
public void setRuleSetReference(RuleSetReference ruleSetReference)
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||