Java Doc for RuleSet.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
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net 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) 


java.lang.Object
   net.sourceforge.pmd.RuleSet

RuleSet
public class RuleSet (Code)
This class represents a collection of rules.
See Also:   Rule




Method Summary
public  voidaddExcludePattern(String excludePattern)
    
public  voidaddExcludePatterns(List<String> excludePatterns)
    
public  voidaddIncludePattern(String includePattern)
    
public  voidaddIncludePatterns(List<String> includePatterns)
    
public  voidaddRule(Rule rule)
    
public  voidaddRuleByReference(String ruleSetFileName, Rule rule)
     Add a new rule by reference to this ruleset.
public  voidaddRuleSet(RuleSet ruleSet)
    
public  voidaddRuleSetByReference(RuleSet ruleSet, boolean allRules)
     Add all rules by reference from one RuleSet to this RuleSet.
public  booleanapplies(File file)
     Check if a given source file should be checked by rules in this RuleSet.
public  voidapply(List acuList, RuleContext ctx)
    
public  voidend(RuleContext ctx)
    
public  booleanequals(Object o)
    
public  StringgetDescription()
    
public  List<String>getExcludePatterns()
    
public  StringgetFileName()
    
public  List<String>getIncludePatterns()
    
public  LanguagegetLanguage()
    
public  StringgetName()
    
public  RulegetRuleByName(String ruleName)
    
public  Collection<Rule>getRules()
     Returns the actual Collection of rules in this ruleset a Collection with the rules.
public  inthashCode()
    
public  voidsetDescription(String description)
    
public  voidsetExcludePatterns(List<String> excludePatterns)
    
public  voidsetFileName(String fileName)
    
public  voidsetIncludePatterns(List<String> includePatterns)
    
public  voidsetLanguage(Language language)
    
public  voidsetName(String name)
    
public  intsize()
    
public  voidstart(RuleContext ctx)
    
public  booleanusesDFA()
    
public  booleanusesTypeResolution()
    



Method Detail
addExcludePattern
public void addExcludePattern(String excludePattern)(Code)



addExcludePatterns
public void addExcludePatterns(List<String> excludePatterns)(Code)



addIncludePattern
public void addIncludePattern(String includePattern)(Code)



addIncludePatterns
public void addIncludePatterns(List<String> includePatterns)(Code)



addRule
public void addRule(Rule rule)(Code)
Add a new rule to this ruleset
Parameters:
  rule - the rule to be added



addRuleByReference
public void addRuleByReference(String ruleSetFileName, Rule rule)(Code)
Add a new rule by reference to this ruleset.
Parameters:
  ruleSetFileName - the ruleset which contains the rule
Parameters:
  rule - the rule to be added



addRuleSet
public void addRuleSet(RuleSet ruleSet)(Code)
Add a whole RuleSet to this RuleSet
Parameters:
  ruleSet - the RuleSet to add



addRuleSetByReference
public void addRuleSetByReference(RuleSet ruleSet, boolean allRules)(Code)
Add all rules by reference from one RuleSet to this RuleSet. The rules can be added as individual references, or collectively as an all rule reference.
Parameters:
  ruleSet - the RuleSet to add
Parameters:
  allRules -



applies
public boolean applies(File file)(Code)
Check if a given source file should be checked by rules in this RuleSet. A file should not be checked if there is an exclude pattern which matches the file, unless there is an include pattern which also matches the file. In other words, include patterns override exclude patterns.
Parameters:
  file - the source file to check true if the file should be checked, false otherwise



apply
public void apply(List acuList, RuleContext ctx)(Code)



end
public void end(RuleContext ctx)(Code)



equals
public boolean equals(Object o)(Code)

See Also:   java.lang.Object.equals(java.lang.Object)



getDescription
public String getDescription()(Code)



getExcludePatterns
public List<String> getExcludePatterns()(Code)



getFileName
public String getFileName()(Code)



getIncludePatterns
public List<String> getIncludePatterns()(Code)



getLanguage
public Language getLanguage()(Code)



getName
public String getName()(Code)



getRuleByName
public Rule getRuleByName(String ruleName)(Code)
Returns the Rule with the given name
Parameters:
  ruleName - the name of the rule to find the rule or null if not found



getRules
public Collection<Rule> getRules()(Code)
Returns the actual Collection of rules in this ruleset a Collection with the rules. All objects are of type Rule



hashCode
public int hashCode()(Code)

See Also:   java.lang.Object.hashCode



setDescription
public void setDescription(String description)(Code)



setExcludePatterns
public void setExcludePatterns(List<String> excludePatterns)(Code)



setFileName
public void setFileName(String fileName)(Code)



setIncludePatterns
public void setIncludePatterns(List<String> includePatterns)(Code)



setLanguage
public void setLanguage(Language language)(Code)



setName
public void setName(String name)(Code)



size
public int size()(Code)
Returns the number of rules in this ruleset an int representing the number of rules



start
public void start(RuleContext ctx)(Code)



usesDFA
public boolean usesDFA()(Code)
true if any rule in the RuleSet needs the DFA layer



usesTypeResolution
public boolean usesTypeResolution()(Code)



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.