Package net.sourceforge.pmd.rules

Class RuleBuilder

java.lang.Object

net.sourceforge.pmd.rules.RuleBuilder

public class RuleBuilder
extends java.lang.Object

Builds a rule, validating its parameters throughout. The builder can define property descriptors, but not override them. For that, use RuleFactory.decorateRule(Rule, RuleSetReference, Element).

Since:

6.0.0

Author:

Clément Fournier

Constructor Summary

Constructors

Constructor	Description
RuleBuilder(java.lang.String name, java.lang.String clazz, java.lang.String language)	Deprecated. Use RuleBuilder(String, ResourceLoader, String, String) with the proper ResourceLoader instead.
RuleBuilder(java.lang.String name, ResourceLoader resourceLoader, java.lang.String clazz, java.lang.String language)

Method Summary

Modifier and Type	Method	Description
void	addExample(java.lang.String example)
Rule	build()
void	defineProperty(PropertyDescriptor<?> descriptor)
void	description(java.lang.String description)
void	externalInfoUrl(java.lang.String externalInfoUrl)
void	maximumLanguageVersion(java.lang.String maximum)
void	message(java.lang.String message)
void	minimumLanguageVersion(java.lang.String minimum)
void	priority(int priorityString)
void	setDeprecated(boolean deprecated)
void	since(java.lang.String sinceStr)
void	usesDFA(boolean usesDFA)
void	usesMultifile(boolean usesMultifile)
void	usesTyperesolution(boolean usesTyperesolution)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RuleBuilder

@Deprecated
public RuleBuilder(java.lang.String name,
                   java.lang.String clazz,
                   java.lang.String language)

Deprecated.

Use RuleBuilder(String, ResourceLoader, String, String) with the proper ResourceLoader instead. The resource loader is used to load the rule implementation class from the class path.

RuleBuilder

public RuleBuilder(java.lang.String name,
                   ResourceLoader resourceLoader,
                   java.lang.String clazz,
                   java.lang.String language)

Method Detail

usesDFA

public void usesDFA(boolean usesDFA)

usesMultifile

public void usesMultifile(boolean usesMultifile)

usesTyperesolution

public void usesTyperesolution(boolean usesTyperesolution)

minimumLanguageVersion

public void minimumLanguageVersion(java.lang.String minimum)

maximumLanguageVersion

public void maximumLanguageVersion(java.lang.String maximum)

since

public void since(java.lang.String sinceStr)

externalInfoUrl

public void externalInfoUrl(java.lang.String externalInfoUrl)

message

public void message(java.lang.String message)

defineProperty

public void defineProperty(PropertyDescriptor<?> descriptor)

setDeprecated

public void setDeprecated(boolean deprecated)

description

public void description(java.lang.String description)

addExample

public void addExample(java.lang.String example)

priority

public void priority(int priorityString)

build

public Rule build()
           throws java.lang.ClassNotFoundException,
                  java.lang.IllegalAccessException,
                  java.lang.InstantiationException

Throws:

java.lang.ClassNotFoundException

java.lang.IllegalAccessException

java.lang.InstantiationException