1 ////////////////////////////////////////////////////////////////////////////////
2 // checkstyle: Checks Java source code for adherence to a set of rules.
3 // Copyright (C) 2001-2015 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 package com.puppycrawl.tools.checkstyle.api;
20
21 /**
22 * <p>
23 * Severity level for a check violation.
24 * </p>
25 * <p>
26 * Each violation of an audit check is assigned one of the severity levels
27 * defined here.
28 * </p>
29 *
30 * @author David Schneider
31 * @author Travis Schneeberger
32 */
33 public enum SeverityLevel
34 {
35 /** security level ignore. */
36 IGNORE,
37 /** security level info. */
38 INFO,
39 /** security level warning. */
40 WARNING,
41 /** security level error. */
42 ERROR;
43
44 @Override
45 public String toString()
46 {
47 return getName();
48 }
49
50 /**
51 * @return the name of this severity level.
52 */
53 public String getName()
54 {
55 return name().toLowerCase();
56 }
57
58 /**
59 * SeverityLevel factory method.
60 *
61 * @param securityLevelName level name, such as "ignore", "info", etc.
62 * @return the <code>SeverityLevel</code>
63 * associated with <code>securityLevelName</code>
64 */
65 public static SeverityLevel getInstance(String securityLevelName)
66 {
67 return valueOf(SeverityLevel.class, securityLevelName.trim()
68 .toUpperCase());
69 }
70 }