Overview | Package | Class | Use | Tree | Deprecated | Index | Help

PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.puppycrawl.tools.checkstyle.api
Class SeverityLevel

    java.lang.Object
      com.puppycrawl.tools.checkstyle.api.SeverityLevel

All Implemented Interfaces:
  Serializable, Comparable

    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
See Also:
  Serialized Form

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

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

Field Detail

### 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.

### ERROR

    public static final SeverityLevel ERROR

  Severity level: error. This is the highest severity level.

Method Detail

### toString

    public String toString()

  Overrides:
    `toString` in class `Object`

### getName

    public String getName()

  Returns:
    the name of this severity level.

### compareTo

    public int compareTo(Object aObject)

  Specified by:
    `compareTo` in interface `Comparable`

### equals

    public boolean equals(Object aObj)

  The equals method.

  Overrides:
    `equals` in class `Object`
  Parameters:
    `aObj` - Object to compare to.
  Returns:
    `true` means equal, `false` means not equal.

### hashCode

    public int hashCode()

  The hashCode method.

  Overrides:
    `hashCode` in class `Object`
  Returns:
    hash code for the object.

### 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`

Overview | Package | Class | Use | Tree | Deprecated | Index | Help

Back to the Checkstyle Home Page
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD