Package net.sourceforge.pmd.reporting

Class Report.ConfigurationError

java.lang.Object

net.sourceforge.pmd.reporting.Report.ConfigurationError

Enclosing class:

Report

public static class Report.ConfigurationError
extends Object

Represents a configuration error for a specific rule.

This might be a missing rule property or rule property with pointless values.

Constructor Summary

Constructors

Constructor	Description
ConfigurationError(Rule theRule, String theIssue)	Creates a new configuration error for a specific rule.

Method Summary

Modifier and Type	Method	Description
String	issue()	Gets the reason for the configuration error.
Rule	rule()	Gets the wrongly configured rule.

Methods inherited from class java.lang.Object

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

Constructor Details

ConfigurationError

public ConfigurationError(Rule theRule,
 String theIssue)

Creates a new configuration error for a specific rule.

Parameters:

theRule - the rule which is configured wrongly

theIssue - the reason, why the configuration is wrong

Method Details

rule

public Rule rule()

Gets the wrongly configured rule.

Returns:

the wrongly configured rule

issue

public String issue()

Gets the reason for the configuration error.

Returns:

the issue