## Uses of Class
net.sourceforge.pmd.RuleContext

Packages that use RuleContext
Package | Description
--- | ---
net.sourceforge.pmd | This is the PMD programming mistake detector.
net.sourceforge.pmd.lang.ecmascript.rule |
net.sourceforge.pmd.lang.java.rule |
net.sourceforge.pmd.lang.java.rule.comments |
net.sourceforge.pmd.lang.java.rule.controversial |
net.sourceforge.pmd.lang.java.rule.design |
net.sourceforge.pmd.lang.jsp.rule |
net.sourceforge.pmd.lang.jsp.rule.basic |
net.sourceforge.pmd.lang.rule |
net.sourceforge.pmd.lang.rule.stat |
net.sourceforge.pmd.lang.rule.xpath |
net.sourceforge.pmd.lang.xml.rule |
net.sourceforge.pmd.processor |

### Uses of RuleContext in net.sourceforge.pmd

Methods in net.sourceforge.pmd that return RuleContext
Modifier and Type | Method and Description
--- | ---
`static RuleContext` | PMD.`newRuleContext(String sourceCodeFilename, File sourceCodeFile)`

Methods in net.sourceforge.pmd with parameters of type RuleContext
Modifier and Type | Method and Description
--- | ---
`void` | RuleSet.`apply(List<? extends Node> acuList, RuleContext ctx)`
`void` | Rule.`apply(List<? extends Node> nodes, RuleContext ctx)` Apply this rule to the given collection of nodes, using the given context.
`void` | RuleSets.`apply(List<Node> acuList, RuleContext ctx, Language language)` Apply all applicable rules to the compilation units.
`void` | RuleChain.`apply(List<Node> nodes, RuleContext ctx, Language language)` Apply the RuleChain to the given Nodes using the given RuleContext, for those rules using the given Language.
`static Report` | Report.`createReport(RuleContext ctx, String fileName)`
`void` | RuleSets.`end(RuleContext ctx)` Notify all rules of the end of processing.
`void` | RuleSet.`end(RuleContext ctx)`
`void` | Rule.`end(RuleContext ctx)` End processing.
`static void` | PMD.`processFiles(PMDConfiguration configuration, RuleSetFactory ruleSetFactory, Collection<File> files, RuleContext ctx, PMD.ProgressMonitor monitor)` An entry point that would typically be used by IDEs intent on providing ongoing feedback and the ability to terminate it at will.
`static void` | PMD.`processFiles(PMDConfiguration configuration, RuleSetFactory ruleSetFactory, List<DataSource> files, RuleContext ctx, List<Renderer> renderers)` Run PMD on a list of files using multiple threads - if more than one is available
`void` | SourceCodeProcessor.`processSourceCode(InputStream sourceCode, RuleSets ruleSets, RuleContext ctx)` Processes the input stream against a rule set using the given input encoding.
`void` | SourceCodeProcessor.`processSourceCode(Reader sourceCode, RuleSets ruleSets, RuleContext ctx)` Processes the input stream against a rule set using the given input encoding.
`static Report` | PMD.`setupReport(RuleSets rs, RuleContext ctx, String fileName)` Create a report, filter out any defective rules, and keep a record of them.
`void` | RuleSets.`start(RuleContext ctx)` Notify all rules of the start of processing.
`void` | RuleSet.`start(RuleContext ctx)`
`void` | Rule.`start(RuleContext ctx)` Start processing.

Constructors in net.sourceforge.pmd with parameters of type RuleContext
Constructor and Description
`RuleContext(RuleContext ruleContext)` Constructor which shares attributes and report listeners with the given RuleContext.

### Uses of RuleContext in net.sourceforge.pmd.lang.ecmascript.rule

Methods in net.sourceforge.pmd.lang.ecmascript.rule with parameters of type RuleContext
Modifier and Type | Method and Description
--- | ---
`void` | AbstractEcmascriptRule.`apply(List<? extends Node> nodes, RuleContext ctx)`
`protected RuleViolation` | EcmascriptRuleViolationFactory.`createRuleViolation(Rule rule, RuleContext ruleContext, Node node, String message)`
`protected RuleViolation` | EcmascriptRuleViolationFactory.`createRuleViolation(Rule rule, RuleContext ruleContext, Node node, String message, int beginLine, int endLine)`
`protected void` | EcmascriptRuleChainVisitor.`indexNodes(List<Node> nodes, RuleContext ctx)`
`protected void` | EcmascriptRuleChainVisitor.`visit(Rule rule, Node node, RuleContext ctx)`
`protected void` | AbstractEcmascriptRule.`visitAll(List<? extends Node> nodes, RuleContext ctx)`

### Uses of RuleContext in net.sourceforge.pmd.lang.java.rule

Methods in net.sourceforge.pmd.lang.java.rule with parameters of type RuleContext
Modifier and Type | Method and Description
--- | ---
`void` | AbstractJavaRule.`apply(List<? extends Node> nodes, RuleContext ctx)`
`void` | AbstractStatisticalJavaRule.`apply(List<? extends Node> nodes, RuleContext ctx)`
`protected RuleViolation` | JavaRuleViolationFactory.`createRuleViolation(Rule rule, RuleContext ruleContext, Node node, String message)`
`protected RuleViolation` | JavaRuleViolationFactory.`createRuleViolation(Rule rule, RuleContext ruleContext, Node node, String message, int beginLine, int endLine)`
`protected void` | JavaRuleChainVisitor.`indexNodes(List<Node> nodes, RuleContext ctx)`
`protected void` | JavaRuleChainVisitor.`visit(Rule rule, Node node, RuleContext ctx)`
`protected void` | AbstractJavaRule.`visitAll(List<? extends Node> nodes, RuleContext ctx)`

Constructors in net.sourceforge.pmd.lang.java.rule with parameters of type RuleContext
Constructor and Description
`JavaRuleViolation(Rule rule, RuleContext ctx, JavaNode node, String message)`
`JavaRuleViolation(Rule rule, RuleContext ctx, JavaNode node, String message, int beginLine, int endLine)`

### Uses of RuleContext in net.sourceforge.pmd.lang.java.rule.comments

Methods in net.sourceforge.pmd.lang.java.rule.comments with parameters of type RuleContext
Modifier and Type | Method and Description
--- | ---
`void` | CommentContentRule.`end(RuleContext ctx)`
`void` | CommentContentRule.`start(RuleContext ctx)` Capture values and perform all the case-conversions once per run

### Uses of RuleContext in net.sourceforge.pmd.lang.java.rule.controversial

Constructors in net.sourceforge.pmd.lang.java.rule.controversial with parameters of type RuleContext
Constructor and Description
`DaaRuleViolation(Rule rule, RuleContext ctx, Node node, String type, String msg, String var, int beginLine, int endLine)`

### Uses of RuleContext in net.sourceforge.pmd.lang.java.rule.design

Methods in net.sourceforge.pmd.lang.java.rule.design with parameters of type RuleContext
Modifier and Type | Method and Description
--- | ---
`void` | GenericClassCounterRule.`end(RuleContext ctx)`
`void` | GenericClassCounterRule.`start(RuleContext ctx)`

### Uses of RuleContext in net.sourceforge.pmd.lang.jsp.rule

Methods in net.sourceforge.pmd.lang.jsp.rule with parameters of type RuleContext
Modifier and Type | Method and Description
--- | ---
`void` | AbstractJspRule.`apply(List<? extends Node> nodes, RuleContext ctx)`
`protected RuleViolation` | JspRuleViolationFactory.`createRuleViolation(Rule rule, RuleContext ruleContext, Node node, String message)`
`protected RuleViolation` | JspRuleViolationFactory.`createRuleViolation(Rule rule, RuleContext ruleContext, Node node, String message, int beginLine, int endLine)`
`protected void` | JspRuleChainVisitor.`indexNodes(List<Node> nodes, RuleContext ctx)`
`protected void` | JspRuleChainVisitor.`visit(Rule rule, Node node, RuleContext ctx)`
`protected void` | AbstractJspRule.`visitAll(List<? extends Node> nodes, RuleContext ctx)`

### Uses of RuleContext in net.sourceforge.pmd.lang.jsp.rule.basic

Methods in net.sourceforge.pmd.lang.jsp.rule.basic with parameters of type RuleContext
Modifier and Type | Method and Description
--- | ---
`void` | DuplicateJspImportsRule.`apply(List<? extends Node> nodes, RuleContext ctx)`

### Uses of RuleContext in net.sourceforge.pmd.lang.rule

Methods in net.sourceforge.pmd.lang.rule with parameters of type RuleContext
Modifier and Type | Method and Description
--- | ---
`void` | RuleViolationFactory.`addViolation(RuleContext ruleContext, Rule rule, Node node, String message, int beginLine, int endLine, Object[] args)`
`void` | AbstractRuleViolationFactory.`addViolation(RuleContext ruleContext, Rule rule, Node node, String message, int beginLine, int endLine, Object[] args)`
`void` | RuleViolationFactory.`addViolation(RuleContext ruleContext, Rule rule, Node node, String message, Object[] args)` Adds a violation to the report.
`void` | AbstractRuleViolationFactory.`addViolation(RuleContext ruleContext, Rule rule, Node node, String message, Object[] args)`
`void` | AbstractDelegateRule.`apply(List<? extends Node> nodes, RuleContext ctx)`
`void` | XPathRule.`apply(List<? extends Node> nodes, RuleContext ctx)` Apply the rule to all nodes.
`void` | MockRule.`apply(List<? extends Node> nodes, RuleContext ctx)`
`protected abstract RuleViolation` | AbstractRuleViolationFactory.`createRuleViolation(Rule rule, RuleContext ruleContext, Node node, String message)`
`protected abstract RuleViolation` | AbstractRuleViolationFactory.`createRuleViolation(Rule rule, RuleContext ruleContext, Node node, String message, int beginLine, int endLine)`
`void` | AbstractDelegateRule.`end(RuleContext ctx)`
`void` | AbstractRule.`end(RuleContext ctx)`
`void` | XPathRule.`evaluate(Node node, RuleContext data)` Evaluate the XPath query with the AST node.
`protected abstract void` | AbstractRuleChainVisitor.`indexNodes(List<Node> nodes, RuleContext ctx)` Index all nodes for visitation by rules.
`void` | AbstractDelegateRule.`start(RuleContext ctx)`
`void` | AbstractRule.`start(RuleContext ctx)`
`protected abstract void` | AbstractRuleChainVisitor.`visit(Rule rule, Node node, RuleContext ctx)` Visit the given rule to the given node.
`void` | RuleChainVisitor.`visitAll(List<Node> nodes, RuleContext ctx)` Visit all the given Nodes provided using the given RuleContext.
`void` | AbstractRuleChainVisitor.`visitAll(List<Node> nodes, RuleContext ctx)`

Constructors in net.sourceforge.pmd.lang.rule with parameters of type RuleContext
Constructor and Description
`ParametricRuleViolation(Rule theRule, RuleContext ctx, T node, String message)`

### Uses of RuleContext in net.sourceforge.pmd.lang.rule.stat

Methods in net.sourceforge.pmd.lang.rule.stat with parameters of type RuleContext
Modifier and Type | Method and Description
--- | ---
`void` | StatisticalRuleHelper.`apply(RuleContext ctx)`

### Uses of RuleContext in net.sourceforge.pmd.lang.rule.xpath

Methods in net.sourceforge.pmd.lang.rule.xpath with parameters of type RuleContext
Modifier and Type | Method and Description
--- | ---
`List<Node>` | XPathRuleQuery.`evaluate(Node node, RuleContext data)` Evaluate the XPath query against the given Node.
`List<Node>` | JaxenXPathRuleQuery.`evaluate(Node node, RuleContext data)` Evaluate the XPath query against the given Node.
`List<Node>` | SaxonXPathRuleQuery.`evaluate(Node node, RuleContext data)` Evaluate the XPath query against the given Node.
`abstract List<Node>` | AbstractXPathRuleQuery.`evaluate(Node node, RuleContext data)` Evaluate the XPath query against the given Node.

### Uses of RuleContext in net.sourceforge.pmd.lang.xml.rule

Methods in net.sourceforge.pmd.lang.xml.rule with parameters of type RuleContext
Modifier and Type | Method and Description
--- | ---
`void` | AbstractXmlRule.`apply(List<? extends Node> nodes, RuleContext ctx)`
`protected RuleViolation` | XmlRuleViolationFactory.`createRuleViolation(Rule rule, RuleContext ruleContext, Node node, String message)`
`protected RuleViolation` | XmlRuleViolationFactory.`createRuleViolation(Rule rule, RuleContext ruleContext, Node node, String message, int beginLine, int endLine)`
`protected void` | XmlRuleChainVisitor.`indexNodes(List<Node> nodes, RuleContext ctx)`
`protected void` | XmlRuleChainVisitor.`visit(Rule rule, Node node, RuleContext ctx)`
`protected void` | AbstractDomXmlRule.`visit(XmlNode node, Attr attr, RuleContext ctx)`
`protected void` | AbstractDomXmlRule.`visit(XmlNode node, CharacterData characterData, RuleContext ctx)`
`protected void` | AbstractDomXmlRule.`visit(XmlNode node, Comment comment, RuleContext ctx)`
`protected void` | AbstractDomXmlRule.`visit(XmlNode node, Document document, RuleContext ctx)`
`protected void` | AbstractDomXmlRule.`visit(XmlNode node, DocumentType documentType, RuleContext ctx)`
`protected void` | AbstractDomXmlRule.`visit(XmlNode node, Element element, RuleContext ctx)`
`protected void` | AbstractDomXmlRule.`visit(XmlNode node, EntityReference entityReference, RuleContext ctx)`
`protected void` | AbstractDomXmlRule.`visit(XmlNode node, Entity entity, RuleContext ctx)`
`protected void` | AbstractDomXmlRule.`visit(XmlNode node, Notation notation, RuleContext ctx)`
`protected void` | AbstractDomXmlRule.`visit(XmlNode node, ProcessingInstruction processingInstruction, RuleContext ctx)`
`protected void` | AbstractXmlRule.`visit(XmlNode node, RuleContext ctx)`
`protected void` | AbstractDomXmlRule.`visit(XmlNode node, RuleContext ctx)`
`protected void` | AbstractDomXmlRule.`visit(XmlNode node, Text text, RuleContext ctx)`
`protected void` | AbstractXmlRule.`visitAll(List<? extends Node> nodes, RuleContext ctx)`
`protected void` | AbstractDomXmlRule.`visitAttributeNodes(XmlNode node, Node domNode, RuleContext ctx)`
`protected void` | AbstractDomXmlRule.`visitDomNode(XmlNode node, Node domNode, RuleContext ctx)`

### Uses of RuleContext in net.sourceforge.pmd.processor

Methods in net.sourceforge.pmd.processor with parameters of type RuleContext
Modifier and Type | Method and Description
--- | ---
`static Thread` | PmdRunnable.`createThread(int id, Runnable r, RuleSetFactory ruleSetFactory, RuleContext ctx)`
`void` | MultiThreadProcessor.`processFiles(RuleSetFactory ruleSetFactory, List<DataSource> files, RuleContext ctx, List<Renderer> renderers)` Run PMD on a list of files using multiple threads.
`void` | MonoThreadProcessor.`processFiles(RuleSetFactory ruleSetFactory, List<DataSource> files, RuleContext ctx, List<Renderer> renderers)`

Constructors in net.sourceforge.pmd.processor with parameters of type RuleContext
Constructor and Description
`PmdThreadFactory(RuleSetFactory ruleSetFactory, RuleContext ctx)`