1 ///////////////////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code and other text files for adherence to a set of rules.
3 // Copyright (C) 2001-2024 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 */
34 public enum SeverityLevel {
35
36 /** Severity level ignore. */
37 IGNORE,
38 /** Severity level info. */
39 INFO,
40 /** Severity level warning. */
41 WARNING,
42 /** Severity level error. */
43 ERROR;
44
45 @Override
46 public String toString() {
47 return getName();
48 }
49
50 /**
51 * Returns name of severity level.
52 *
53 * @return the name of this severity level.
54 */
55 public String getName() {
56 return name().toLowerCase(Locale.ENGLISH);
57 }
58
59 /**
60 * SeverityLevel factory method.
61 *
62 * @param securityLevelName level name, such as "ignore", "info", etc.
63 * @return the {@code SeverityLevel}
64 * associated with {@code securityLevelName}
65 */
66 public static SeverityLevel getInstance(String securityLevelName) {
67 return valueOf(SeverityLevel.class, securityLevelName.trim()
68 .toUpperCase(Locale.ENGLISH));
69 }
70
71 }