Java Doc for Rule.java in » Code-Analyzer » pmd-4.2rc1 » net » sourceforge » pmd » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Code Analyzer » pmd 4.2rc1 » net.sourceforge.pmd

Source Cross Reference Class Diagram Java Document (Java Doc)

net.sourceforge.pmd .Rule

All known Subclasses:   net.sourceforge.pmd .CommonAbstractRule,  net.sourceforge.pmd .AbstractDelegateRule,
Rule
public interface Rule (Code)
This is the basic Rule interface for PMD rules.

Field Summary
final public static int LOWEST_PRIORITY

final public static String[] PRIORITIES


Method Summary
void addExample(String example)
     Add a single example for this Rule.
void addProperties(Properties properties)
     Add a set of properties to this Rule.
void addProperty(String name, String property)
     Add a specific property to this Rule.
void addRuleChainVisit(String astNodeName)
     Adds an AST node name to be visited by the Rule on the RuleChain.
void apply(List astCompilationUnits, RuleContext ctx)
     Apply this rule to the given collection of compilation units, using the given context.
void end(RuleContext ctx)
     End processing.
boolean getBooleanProperty(String name)
     Get the boolean value for the given property.
String getDescription()
     Get the description of this Rule.
double getDoubleProperty(String name)
     Get the double value for the given property.
String getExample()

List<String> getExamples()
     Get the list of examples for this Rule.
String getExternalInfoUrl()
     Get a URL for external information about this Rule.
int getIntProperty(String name)
     Get the int value for the given property.
String getMessage()
     Get the message to show when this Rule identifies a violation.
String getName()
     Get the name of this Rule.
int getPriority()
     Get the priority of this Rule.
String getPriorityName()
     Get a name for the priority of this Rule.
Properties getProperties()
     Get all properties for this Rule.
List<String> getRuleChainVisits()
     Gets the collection of AST node names visited by the Rule on the RuleChain.
String getRuleClass()
     Get the class of this Rule.
String getRuleSetName()
     Get the name of the RuleSet containing this Rule.
String getSince()
     Get the version of PMD in which this Rule was added.
String getStringProperty(String name)
     Get the java.util.String value for the given property.
boolean hasProperty(String name)
     Get whether this Rule has a property of the given name.
boolean include()

PropertyDescriptor propertyDescriptorFor(String name)
     Get the PropertyDescriptor for the given property.
void setDescription(String description)
     Set the description of this Rule.
void setExternalInfoUrl(String externalInfoUrl)
     Set a URL for external information about this Rule.
void setInclude(boolean include)

void setMessage(String message)
     Set the message to show when this Rule identifies a violation.
void setName(String name)
     Set the name of this Rule.
void setPriority(int priority)
     Set the priority of this Rule.
void setRuleClass(String ruleClass)
     Set the class of this Rule.
void setRuleSetName(String name)
     Set the name of the RuleSet containing this Rule.
void setSince(String since)
     Set the version of PMD in which this Rule was added.
void setUsesDFA()
     Sets whether this Rule uses Data Flow Analysis.
void setUsesTypeResolution()
     Sets whether this Rule uses Type Resolution.
void start(RuleContext ctx)
     Start processing.
boolean usesDFA()
     Gets whether this Rule uses Data Flow Analysis.
boolean usesRuleChain()
     Gets whether this Rule uses the RuleChain.
boolean usesTypeResolution()
     Gets whether this Rule uses Type Resolution.

Field Detail
LOWEST_PRIORITY
final public static int LOWEST_PRIORITY(Code)

PRIORITIES
final public static String[] PRIORITIES(Code)

Method Detail
addExample
void addExample(String example)(Code)
Add a single example for this Rule.

addProperties
void addProperties(Properties properties)(Code)
Add a set of properties to this Rule.

addProperty
void addProperty(String name, String property)(Code)
Add a specific property to this Rule.

addRuleChainVisit
void addRuleChainVisit(String astNodeName)(Code)
Adds an AST node name to be visited by the Rule on the RuleChain.

apply
void apply(List astCompilationUnits, RuleContext ctx)(Code)
Apply this rule to the given collection of compilation units, using the given context.

end
void end(RuleContext ctx)(Code)
End processing. Called once, after apply() is last called.

getBooleanProperty
boolean getBooleanProperty(String name)(Code)
Get the boolean value for the given property.

getDescription
String getDescription()(Code)
Get the description of this Rule.

getDoubleProperty
double getDoubleProperty(String name)(Code)
Get the double value for the given property.

getExample
String getExample()(Code)
Still used by the JDeveloper plugin

getExamples
List<String> getExamples()(Code)
Get the list of examples for this Rule.

getExternalInfoUrl
String getExternalInfoUrl()(Code)
Get a URL for external information about this Rule.

getIntProperty
int getIntProperty(String name)(Code)
Get the int value for the given property.

getMessage
String getMessage()(Code)
Get the message to show when this Rule identifies a violation.

getName
String getName()(Code)
Get the name of this Rule.

getPriority
int getPriority()(Code)
Get the priority of this Rule.

getPriorityName
String getPriorityName()(Code)
Get a name for the priority of this Rule.

getProperties
Properties getProperties()(Code)
Get all properties for this Rule. the properties for the rule

getRuleChainVisits
List<String> getRuleChainVisits()(Code)
Gets the collection of AST node names visited by the Rule on the RuleChain.

getRuleClass
String getRuleClass()(Code)
Get the class of this Rule.

getRuleSetName
String getRuleSetName()(Code)
Get the name of the RuleSet containing this Rule.
See Also:   RuleSet

getSince
String getSince()(Code)
Get the version of PMD in which this Rule was added. Return null if not applicable.

getStringProperty
String getStringProperty(String name)(Code)
Get the java.util.String value for the given property.

hasProperty
boolean hasProperty(String name)(Code)
Get whether this Rule has a property of the given name.

include
boolean include()(Code)
TODO What is this?

propertyDescriptorFor
PropertyDescriptor propertyDescriptorFor(String name)(Code)
Get the PropertyDescriptor for the given property.

setDescription
void setDescription(String description)(Code)
Set the description of this Rule.

setExternalInfoUrl
void setExternalInfoUrl(String externalInfoUrl)(Code)
Set a URL for external information about this Rule.

setInclude
void setInclude(boolean include)(Code)
TODO What is this?

setMessage
void setMessage(String message)(Code)
Set the message to show when this Rule identifies a violation.

setName
void setName(String name)(Code)
Set the name of this Rule.

setPriority
void setPriority(int priority)(Code)
Set the priority of this Rule.

setRuleClass
void setRuleClass(String ruleClass)(Code)
Set the class of this Rule.

setRuleSetName
void setRuleSetName(String name)(Code)
Set the name of the RuleSet containing this Rule.
See Also:   RuleSet

setSince
void setSince(String since)(Code)
Set the version of PMD in which this Rule was added.

setUsesDFA
void setUsesDFA()(Code)
Sets whether this Rule uses Data Flow Analysis.

setUsesTypeResolution
void setUsesTypeResolution()(Code)
Sets whether this Rule uses Type Resolution.

start
void start(RuleContext ctx)(Code)
Start processing. Called once, before apply() is first called.

usesDFA
boolean usesDFA()(Code)
Gets whether this Rule uses Data Flow Analysis.

usesRuleChain
boolean usesRuleChain()(Code)
Gets whether this Rule uses the RuleChain.

usesTypeResolution
boolean usesTypeResolution()(Code)
Gets whether this Rule uses Type Resolution.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.