net.sourceforge.pmd

Class CommonAbstractRule

public abstract class CommonAbstractRule extends Object implements Rule

Basic abstract implementation of all parser-independent methods of the Rule interface.

Author: pieter_van_raemdonck - Application Engineers NV/SA - www.ae.be

Method Summary
void	addExample(String example)
void	addProperties(Properties properties)
void	addProperty(String name, String value)
void	addRuleChainVisit(String astNodeName)
protected static Map<String,PropertyDescriptor>	asFixedMap(PropertyDescriptor[] descriptors)
protected static Map<String,PropertyDescriptor>	asFixedMap(PropertyDescriptor descriptor)
void	end(RuleContext ctx)
boolean[]	getBooleanProperties(PropertyDescriptor descriptor)
boolean	getBooleanProperty(String name)
boolean	getBooleanProperty(PropertyDescriptor descriptor)
String	getDescription()
double[]	getDoubleProperties(PropertyDescriptor descriptor)
double	getDoubleProperty(String name)
double	getDoubleProperty(PropertyDescriptor descriptor)
String	getExample()
List<String>	getExamples()
String	getExternalInfoUrl()
int[]	getIntProperties(PropertyDescriptor descriptor)
int	getIntProperty(String name)
int	getIntProperty(PropertyDescriptor descriptor)
String	getMessage()
String	getName()
int	getPriority()
String	getPriorityName()
Properties	getProperties()
List<String>	getRuleChainVisits()
String	getRuleClass()
String	getRuleSetName()
String	getSince()
String[]	getStringProperties(PropertyDescriptor descriptor)
String	getStringProperty(String name)
String	getStringProperty(PropertyDescriptor descriptor)
Class[]	getTypeProperties(PropertyDescriptor descriptor)
Class	getTypeProperty(PropertyDescriptor descriptor)
boolean	hasProperty(String name)
boolean	include()
protected Map<String,PropertyDescriptor>	propertiesByName() Return all the relevant properties for the receiver by overriding in subclasses as necessary.
PropertyDescriptor	propertyDescriptorFor(String name)
void	setDescription(String description)
void	setExternalInfoUrl(String externalInfoUrl)
void	setInclude(boolean include)
void	setMessage(String message)
void	setName(String name)
void	setPriority(int priority)
void	setProperties(PropertyDescriptor descriptor, Object[] values)
void	setProperty(PropertyDescriptor descriptor, Object value)
void	setRuleClass(String ruleClass)
void	setRuleSetName(String ruleSetName)
void	setSince(String since)
void	setUsesDFA()
void	setUsesTypeResolution()
void	start(RuleContext ctx)
boolean	usesDFA()
boolean	usesRuleChain()
boolean	usesTypeResolution()

Method Detail

addExample

public void addExample(String example)

addProperties

public void addProperties(Properties properties)

Deprecated:

addProperty

public void addProperty(String name, String value)

Deprecated:

addRuleChainVisit

public void addRuleChainVisit(String astNodeName)

asFixedMap

protected static Map<String,PropertyDescriptor> asFixedMap(PropertyDescriptor[] descriptors)

asFixedMap

protected static Map<String,PropertyDescriptor> asFixedMap(PropertyDescriptor descriptor)

end

public void end(RuleContext ctx)

getBooleanProperties

public boolean[] getBooleanProperties(PropertyDescriptor descriptor)

getBooleanProperty

public boolean getBooleanProperty(String name)

Deprecated: - use getBooleanProperty(PropertyDescriptor) instead

getBooleanProperty

public boolean getBooleanProperty(PropertyDescriptor descriptor)

getDescription

public String getDescription()

getDoubleProperties

public double[] getDoubleProperties(PropertyDescriptor descriptor)

getDoubleProperty

public double getDoubleProperty(String name)

Deprecated: - use getDoubleProperty(PropertyDescriptor) instead

getDoubleProperty

public double getDoubleProperty(PropertyDescriptor descriptor)

getExample

public String getExample()

getExamples

public List<String> getExamples()

getExternalInfoUrl

public String getExternalInfoUrl()

getIntProperties

public int[] getIntProperties(PropertyDescriptor descriptor)

getIntProperty

public int getIntProperty(String name)

Deprecated: - use getIntProperty(PropertyDescriptor) instead

getIntProperty

public int getIntProperty(PropertyDescriptor descriptor)

getMessage

public String getMessage()

getName

public String getName()

getPriority

public int getPriority()

getPriorityName

public String getPriorityName()

getProperties

public Properties getProperties()

Deprecated: - retrieve by name using getProperty or getProperties

getRuleChainVisits

public List<String> getRuleChainVisits()

getRuleClass

public String getRuleClass()

getRuleSetName

public String getRuleSetName()

getSince

public String getSince()

getStringProperties

public String[] getStringProperties(PropertyDescriptor descriptor)

getStringProperty

public String getStringProperty(String name)

Deprecated: - use getStringProperty(PropertyDescriptor) instead

getStringProperty

public String getStringProperty(PropertyDescriptor descriptor)

getTypeProperties

public Class[] getTypeProperties(PropertyDescriptor descriptor)

getTypeProperty

public Class getTypeProperty(PropertyDescriptor descriptor)

hasProperty

public boolean hasProperty(String name)

Deprecated: - property values will be guaranteed available via default values

include

public boolean include()

propertiesByName

protected Map<String,PropertyDescriptor> propertiesByName()

Return all the relevant properties for the receiver by overriding in subclasses as necessary.

Returns: Map

propertyDescriptorFor

public PropertyDescriptor propertyDescriptorFor(String name)

setDescription

public void setDescription(String description)

setExternalInfoUrl

public void setExternalInfoUrl(String externalInfoUrl)

setInclude

public void setInclude(boolean include)

setMessage

public void setMessage(String message)

setName

public void setName(String name)

setPriority

public void setPriority(int priority)

setProperties

public void setProperties(PropertyDescriptor descriptor, Object[] values)

setProperty

public void setProperty(PropertyDescriptor descriptor, Object value)

setRuleClass

public void setRuleClass(String ruleClass)

setRuleSetName

public void setRuleSetName(String ruleSetName)

setSince

public void setSince(String since)

setUsesDFA

public void setUsesDFA()

setUsesTypeResolution

public void setUsesTypeResolution()

start

public void start(RuleContext ctx)

usesDFA

public boolean usesDFA()

usesRuleChain

public boolean usesRuleChain()

usesTypeResolution

public boolean usesTypeResolution()