Package com.qulice.pmd

Interface PmdError

All Known Implementing Classes:

PmdError.OfConfigError, PmdError.OfProcessingError, PmdError.OfRuleViolation

public interface PmdError

Represents one PMD error (usually it will be violation).

Since:

1.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	PmdError.OfConfigError	PmdError backed by a ConfigError.
static final class	PmdError.OfProcessingError	PmdError backed by a ProcessingError.
static final class	PmdError.OfRuleViolation	PmdError backed by a 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.

Method Details

name

String name()

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

Returns:

Error name.

fileName

String fileName()

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

Returns:

File name.

lines

String lines()

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

Returns:

Formatted line range.

description

String description()

Returns error description.

Returns:

Description.