com.puppycrawl.tools.checkstyle.api

Class SeverityLevel

Implemented Interfaces:
Comparable, Serializable

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 SeverityLevel
ERROR
Severity level: error.
static SeverityLevel
IGNORE
Severity level: ignore.
static SeverityLevel
INFO
Severity level: informational.
static SeverityLevel
WARNING
Severity level: warning.

Method Summary

int
compareTo(Object aObject)
boolean
equals(Object aObj)
The equals method.
static SeverityLevel
getInstance(String aSeverityName)
SeverityLevel factory method.
String
getName()
int
hashCode()
The hashCode method.
String
toString()

Field Details

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 Details

compareTo

public int compareTo(Object aObject)

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()