net.sourceforge.pmd

Interface RuleViolation

All Known Implementing Classes:

ParametricRuleViolation

public interface RuleViolation

A RuleViolation is created by a Rule when it identifies a violation of the Rule constraints.

See Also:

Rule

Method Summary

Methods

Modifier and Type	Method and Description
int	getBeginColumn() Get the column number of the begin line in the source file in which this violation was identified.
int	getBeginLine() Get the begin line number in the source file in which this violation was identified.
java.lang.String	getClassName() Get the name of the Class in which this violation was identified.
java.lang.String	getDescription() Get the description of this violation.
int	getEndColumn() Get the column number of the end line in the source file in which this violation was identified.
int	getEndLine() Get the end line number in the source file in which this violation was identified.
java.lang.String	getFilename() Get the source file name in which this violation was identified.
java.lang.String	getMethodName() Get the method name in which this violation was identified.
java.lang.String	getPackageName() Get the package name of the Class in which this violation was identified.
Rule	getRule() Get the Rule which identified this violation.
java.lang.String	getVariableName() Get the variable name on which this violation was identified.
boolean	isSuppressed() Indicates whether this violation has been suppressed.

Method Detail

getRule

Rule getRule()

Get the Rule which identified this violation.

Returns:

The identifying Rule.

getDescription

java.lang.String getDescription()

Get the description of this violation.

Returns:

The description.

isSuppressed

boolean isSuppressed()

Indicates whether this violation has been suppressed.

Returns:

true if this violation is suppressed, false otherwise.

getFilename

java.lang.String getFilename()

Get the source file name in which this violation was identified.

Returns:

The source file name.

getBeginLine

int getBeginLine()

Get the begin line number in the source file in which this violation was identified.

Returns:

Begin line number.

getBeginColumn

int getBeginColumn()

Get the column number of the begin line in the source file in which this violation was identified.

Returns:

Begin column number.

getEndLine

int getEndLine()

Get the end line number in the source file in which this violation was identified.

Returns:

End line number.

getEndColumn

int getEndColumn()

Get the column number of the end line in the source file in which this violation was identified.

Returns:

End column number.

getPackageName

java.lang.String getPackageName()

Get the package name of the Class in which this violation was identified.

Returns:

The package name.

getClassName

java.lang.String getClassName()

Get the name of the Class in which this violation was identified.

Returns:

The Class name.

getMethodName

java.lang.String getMethodName()

Get the method name in which this violation was identified.

Returns:

The method name.

getVariableName

java.lang.String getVariableName()

Get the variable name on which this violation was identified.

Returns:

The variable name.