Package net.sourceforge.pmd.lang.rule

Class ParametricRuleViolation

java.lang.Object

net.sourceforge.pmd.lang.rule.ParametricRuleViolation

All Implemented Interfaces:

RuleViolation

@Deprecated
@InternalApi
public class ParametricRuleViolation
extends Object
implements RuleViolation

Deprecated.

This is internal. Clients should exclusively use RuleViolation.

Field Summary

Fields

Modifier and Type	Field	Description
protected String	description	Deprecated.
protected Rule	rule	Deprecated.

Fields inherited from interface net.sourceforge.pmd.RuleViolation

CLASS_NAME, DEFAULT_COMPARATOR, METHOD_NAME, PACKAGE_NAME, VARIABLE_NAME

Constructor Summary

Constructors

Constructor	Description
ParametricRuleViolation(Rule theRule, FileLocation location, String message)	Deprecated.
ParametricRuleViolation(Rule theRule, FileLocation location, String message, Map<String,String> additionalInfo)	Deprecated.
ParametricRuleViolation(Rule theRule, Reportable node, String message)	Deprecated. Update tests that use this not to call the ctor directly.
ParametricRuleViolation(Rule theRule, Reportable node, String message, Map<String,String> additionalInfo)	Deprecated.

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getAdditionalInfo()	Deprecated. A map of additional key-value pairs known about this violation.
String	getDescription()	Deprecated. Get the description of this violation.
FileLocation	getLocation()	Deprecated. Returns the location where the violation should be reported.
Rule	getRule()	Deprecated. Get the Rule which identified this violation.
String	toString()	Deprecated.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sourceforge.pmd.RuleViolation

getBeginColumn, getBeginLine, getClassName, getEndColumn, getEndLine, getFileId, getMethodName, getPackageName, getVariableName

Field Detail

rule

protected final Rule rule

Deprecated.

description

protected final String description

Deprecated.

Constructor Detail

ParametricRuleViolation

@Deprecated
public ParametricRuleViolation(Rule theRule,
                               Reportable node,
                               String message)

Deprecated.

Update tests that use this not to call the ctor directly.

ParametricRuleViolation

public ParametricRuleViolation(Rule theRule,
                               FileLocation location,
                               String message)

Deprecated.

ParametricRuleViolation

public ParametricRuleViolation(Rule theRule,
                               Reportable node,
                               String message,
                               Map<String,String> additionalInfo)

Deprecated.

ParametricRuleViolation

public ParametricRuleViolation(Rule theRule,
                               FileLocation location,
                               String message,
                               Map<String,String> additionalInfo)

Deprecated.

Method Detail

getAdditionalInfo

public Map<String,String> getAdditionalInfo()

Deprecated.

Description copied from interface: RuleViolation

A map of additional key-value pairs known about this violation. What data is in there is language specific. Common keys supported by several languages are defined as constants on this interface. The map is unmodifiable.

Specified by:

getAdditionalInfo in interface RuleViolation

getRule

public Rule getRule()

Deprecated.

Description copied from interface: RuleViolation

Get the Rule which identified this violation.

Specified by:

getRule in interface RuleViolation

Returns:

The identifying Rule.

getDescription

public String getDescription()

Deprecated.

Description copied from interface: RuleViolation

Get the description of this violation.

Specified by:

getDescription in interface RuleViolation

Returns:

The description.

getLocation

public FileLocation getLocation()

Deprecated.

Description copied from interface: RuleViolation

Returns the location where the violation should be reported.

Specified by:

getLocation in interface RuleViolation

toString

public String toString()

Deprecated.

Overrides:

toString in class Object