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