Package com.qulice.pmd

Class PmdError.OfRuleViolation

java.lang.Object

com.qulice.pmd.PmdError.OfRuleViolation

All Implemented Interfaces:

PmdError

Enclosing interface:

PmdError

public static final class PmdError.OfRuleViolation
extends Object
implements PmdError

PmdError backed by a RuleViolation.

Since:

1.0

Nested Class Summary

Nested classes/interfaces inherited from interface com.qulice.pmd.PmdError

PmdError.OfConfigError, PmdError.OfProcessingError, PmdError.OfRuleViolation

Constructor Summary

Constructors

Constructor	Description
OfRuleViolation(net.sourceforge.pmd.RuleViolation violation)	Creates a new PmdError, representing given RuleViolation.

Method Summary

Modifier and Type	Method	Description
String	description()	Returns error description.
String	fileName()	Returns file name which caused this error.
String	lines()	Returns formatted line range which cause this error.
String	name()	Returns error name which is short, fixed, human-readable category of the error.

Methods inherited from class java.lang.Object

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

Constructor Details

OfRuleViolation

public OfRuleViolation(net.sourceforge.pmd.RuleViolation violation)

Creates a new PmdError, representing given RuleViolation.

Parameters:

violation - Internal RuleViolation.

Method Details

name

public String name()

Description copied from interface: PmdError

Returns error name which is short, fixed, human-readable category of the error.

Specified by:

name in interface PmdError

Returns:

Error name.

fileName

public String fileName()

Description copied from interface: PmdError

Returns file name which caused this error. May return sentinel value if file information is not available.

Specified by:

fileName in interface PmdError

Returns:

File name.

lines

public String lines()

Description copied from interface: PmdError

Returns formatted line range which cause this error. May return sentinel value if line information is not available.

Specified by:

lines in interface PmdError

Returns:

Formatted line range.

description

public String description()

Description copied from interface: PmdError

Returns error description.

Specified by:

description in interface PmdError

Returns:

Description.