com.puppycrawl.tools.checkstyle.api

Enum SeverityLevel

java.lang.Object

java.lang.Enum<SeverityLevel>

com.puppycrawl.tools.checkstyle.api.SeverityLevel

All Implemented Interfaces:

Serializable, Comparable<SeverityLevel>

public enum SeverityLevel
extends Enum<SeverityLevel>

Severity level for a check violation.

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

Author:

David Schneider, Travis Schneeberger, Mehmet Can Cömert

Enum Constant Summary

Enum Constants

Enum Constant and Description
ERROR Severity level error.
IGNORE Severity level ignore.
INFO Severity level info.
WARNING Severity level warning.

Method Summary

Modifier and Type	Method and Description
static SeverityLevel	getInstance(String securityLevelName) SeverityLevel factory method.
String	getName() Returns name of severity level.
String	toString()
static SeverityLevel	valueOf(String name) Returns the enum constant of this type with the specified name.
static SeverityLevel[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

IGNORE

public static final SeverityLevel IGNORE

Severity level ignore.

INFO

public static final SeverityLevel INFO

Severity level info.

WARNING

public static final SeverityLevel WARNING

Severity level warning.

ERROR

public static final SeverityLevel ERROR

Severity level error.

Method Detail

values

public static SeverityLevel[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SeverityLevel c : SeverityLevel.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SeverityLevel valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<SeverityLevel>

getName

public String getName()

Returns name of severity level.

Returns:

the name of this severity level.

getInstance

public static SeverityLevel getInstance(String securityLevelName)

SeverityLevel factory method.

Parameters:

securityLevelName - level name, such as "ignore", "info", etc.

Returns:

the SeverityLevel associated with securityLevelName