net.sourceforge.pmd

Class Report.SuppressedViolation

java.lang.Object

net.sourceforge.pmd.Report.SuppressedViolation

Enclosing class:

Report

public static class Report.SuppressedViolation
extends java.lang.Object

Represents a violation, that has been suppressed.

Constructor Summary

Constructors

Constructor and Description
SuppressedViolation(RuleViolation rv, boolean isNOPMD, java.lang.String userMessage) Creates a suppressed violation.

Method Summary

Modifier and Type	Method and Description
RuleViolation	getRuleViolation()
java.lang.String	getUserMessage()
boolean	suppressedByAnnotation() Returns true if the violation has been suppressed via a annotation.
boolean	suppressedByNOPMD() Returns true if the violation has been suppressed via a NOPMD comment.

Methods inherited from class java.lang.Object

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

Constructor Detail

SuppressedViolation

public SuppressedViolation(RuleViolation rv,
                           boolean isNOPMD,
                           java.lang.String userMessage)

Creates a suppressed violation.

Parameters:

rv - the actual violation, that has been suppressed

isNOPMD - the suppression mode: true if it is suppressed via a NOPMD comment, false if suppressed via annotations.

userMessage - contains the suppressed code line or null

Method Detail

suppressedByNOPMD

public boolean suppressedByNOPMD()

Returns true if the violation has been suppressed via a NOPMD comment.

Returns:

true if the violation has been suppressed via a NOPMD comment.

suppressedByAnnotation

public boolean suppressedByAnnotation()

Returns true if the violation has been suppressed via a annotation.

Returns:

true if the violation has been suppressed via a annotation.

getRuleViolation

public RuleViolation getRuleViolation()

getUserMessage

public java.lang.String getUserMessage()