View Javadoc
1   ////////////////////////////////////////////////////////////////////////////////
2   // checkstyle: Checks Java source code for adherence to a set of rules.
3   // Copyright (C) 2001-2017 the original author or authors.
4   //
5   // This library is free software; you can redistribute it and/or
6   // modify it under the terms of the GNU Lesser General Public
7   // License as published by the Free Software Foundation; either
8   // version 2.1 of the License, or (at your option) any later version.
9   //
10  // This library is distributed in the hope that it will be useful,
11  // but WITHOUT ANY WARRANTY; without even the implied warranty of
12  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  // Lesser General Public License for more details.
14  //
15  // You should have received a copy of the GNU Lesser General Public
16  // License along with this library; if not, write to the Free Software
17  // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  ////////////////////////////////////////////////////////////////////////////////
19  
20  package com.puppycrawl.tools.checkstyle.api;
21  
22  import java.util.Locale;
23  
24  /**
25   * <p>
26   * Severity level for a check violation.
27   * </p>
28   * <p>
29   * Each violation of an audit check is assigned one of the severity levels
30   * defined here.
31   * </p>
32   *
33   * @author David Schneider
34   * @author Travis Schneeberger
35   * @author Mehmet Can Cömert
36   */
37  public enum SeverityLevel {
38      /** Severity level ignore. */
39      IGNORE,
40      /** Severity level info. */
41      INFO,
42      /** Severity level warning. */
43      WARNING,
44      /** Severity level error. */
45      ERROR;
46  
47      @Override
48      public String toString() {
49          return getName();
50      }
51  
52      /**
53       * Returns name of severity level.
54       * @return the name of this severity level.
55       */
56      public String getName() {
57          return name().toLowerCase(Locale.ENGLISH);
58      }
59  
60      /**
61       * SeverityLevel factory method.
62       *
63       * @param securityLevelName level name, such as "ignore", "info", etc.
64       * @return the {@code SeverityLevel}
65       *     associated with {@code securityLevelName}
66       */
67      public static SeverityLevel getInstance(String securityLevelName) {
68          return valueOf(SeverityLevel.class, securityLevelName.trim()
69                  .toUpperCase(Locale.ENGLISH));
70      }
71  }