001///////////////////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
003// Copyright (C) 2001-2024 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 * Severity level for a check violation.
026 *
027 * <p>
028 * Each violation of an audit check is assigned one of the severity levels
029 * defined here.
030 * </p>
031 *
032 */
033public enum SeverityLevel {
034
035    /** Severity level ignore. */
036    IGNORE,
037    /** Severity level info. */
038    INFO,
039    /** Severity level warning. */
040    WARNING,
041    /** Severity level error. */
042    ERROR;
043
044    @Override
045    public String toString() {
046        return getName();
047    }
048
049    /**
050     * Returns name of severity level.
051     *
052     * @return the name of this severity level.
053     */
054    public String getName() {
055        return name().toLowerCase(Locale.ENGLISH);
056    }
057
058    /**
059     * SeverityLevel factory method.
060     *
061     * @param securityLevelName level name, such as "ignore", "info", etc.
062     * @return the {@code SeverityLevel}
063     *     associated with {@code securityLevelName}
064     */
065    public static SeverityLevel getInstance(String securityLevelName) {
066        return valueOf(SeverityLevel.class, securityLevelName.trim()
067                .toUpperCase(Locale.ENGLISH));
068    }
069
070}