Package net.sourceforge.pmd.cache

Class CachedRuleViolation

java.lang.Object

net.sourceforge.pmd.cache.CachedRuleViolation

All Implemented Interfaces:

RuleViolation

@Deprecated
@InternalApi
public final class CachedRuleViolation
extends Object
implements RuleViolation

Deprecated.

This is internal API, will be hidden with 7.0.0

A RuleViolation implementation that is immutable, and therefore cache friendly

Field Summary

Fields inherited from interface net.sourceforge.pmd.RuleViolation

CLASS_NAME, DEFAULT_COMPARATOR, METHOD_NAME, PACKAGE_NAME, VARIABLE_NAME

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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sourceforge.pmd.RuleViolation

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

Method Detail

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

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