001////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code for adherence to a set of rules.
003// Copyright (C) 2001-2018 the original author or authors.
004//
005// This library is free software; you can redistribute it and/or
006// modify it under the terms of the GNU Lesser General Public
007// License as published by the Free Software Foundation; either
008// version 2.1 of the License, or (at your option) any later version.
009//
010// This library is distributed in the hope that it will be useful,
011// but WITHOUT ANY WARRANTY; without even the implied warranty of
012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013// Lesser General Public License for more details.
014//
015// You should have received a copy of the GNU Lesser General Public
016// License along with this library; if not, write to the Free Software
017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
018////////////////////////////////////////////////////////////////////////////////
019
020package com.puppycrawl.tools.checkstyle.api;
021
022import java.util.Locale;
023
024/**
025 * <p>
026 * Severity level for a check violation.
027 * </p>
028 * <p>
029 * Each violation of an audit check is assigned one of the severity levels
030 * defined here.
031 * </p>
032 *
033 * @author David Schneider
034 * @author Travis Schneeberger
035 * @author Mehmet Can Cömert
036 */
037public enum SeverityLevel {
038
039    /** Severity level ignore. */
040    IGNORE,
041    /** Severity level info. */
042    INFO,
043    /** Severity level warning. */
044    WARNING,
045    /** Severity level error. */
046    ERROR;
047
048    @Override
049    public String toString() {
050        return getName();
051    }
052
053    /**
054     * Returns name of severity level.
055     * @return the name of this severity level.
056     */
057    public String getName() {
058        return name().toLowerCase(Locale.ENGLISH);
059    }
060
061    /**
062     * SeverityLevel factory method.
063     *
064     * @param securityLevelName level name, such as "ignore", "info", etc.
065     * @return the {@code SeverityLevel}
066     *     associated with {@code securityLevelName}
067     */
068    public static SeverityLevel getInstance(String securityLevelName) {
069        return valueOf(SeverityLevel.class, securityLevelName.trim()
070                .toUpperCase(Locale.ENGLISH));
071    }
072
073}