com.puppycrawl.tools.checkstyle.api

Class SeverityLevel

public final class SeverityLevel extends Object implements Comparable, Serializable

Severity level for a check violation.

Each violation of an audit check is assigned one of the severity levels defined here.

Author: David Schneider

Field Summary
static SeverityLevelERROR
Severity level: error.
static SeverityLevelIGNORE
Severity level: ignore.
static SeverityLevelINFO
Severity level: informational.
static SeverityLevelWARNING
Severity level: warning.
Method Summary
intcompareTo(Object aObject)
{@inheritDoc}
booleanequals(Object aObj)
The equals method.
static SeverityLevelgetInstance(String aSeverityName)
SeverityLevel factory method.
StringgetName()
inthashCode()
The hashCode method.
StringtoString()
{@inheritDoc}

Field Detail

ERROR

public static final SeverityLevel ERROR
Severity level: error. This is the highest severity level.

IGNORE

public static final SeverityLevel IGNORE
Severity level: ignore. This is the lowest severity level.

INFO

public static final SeverityLevel INFO
Severity level: informational.

WARNING

public static final SeverityLevel WARNING
Severity level: warning.

Method Detail

compareTo

public int compareTo(Object aObject)
{@inheritDoc}

equals

public boolean equals(Object aObj)
The equals method.

Parameters: aObj Object to compare to.

Returns: true means equal, false means not equal.

getInstance

public static SeverityLevel getInstance(String aSeverityName)
SeverityLevel factory method.

Parameters: aSeverityName severity name, such as "ignore", "info", etc.

Returns: the SeverityLevel associated with aSeverityName

getName

public String getName()

Returns: the name of this severity level.

hashCode

public int hashCode()
The hashCode method.

Returns: hash code for the object.

toString

public String toString()
{@inheritDoc}