org.codehaus.mojo.findbugs.ThresholdParameter Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of findbugs-maven-plugin Show documentation
This Plug-In generates reports based on the FindBugs Library
There is a newer version: 3.0.5
Show newest version
package org.codehaus.mojo.findbugs;

/* Copyright (c) 2004, The Codehaus
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 * of the Software, and to permit persons to whom the Software is furnished to do
 * so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

import edu.umd.cs.findbugs.Detector;

/**
 * Constant values for the configuration parameter threshold.
 * 
 * @author $Author: cyrill $
 * @author Cyrill Ruettimann
 * @version $Id: ThresholdParameter.java 2561 2006-10-24 21:06:39Z gleclaire $
 */
public final class ThresholdParameter
{

    /**
     * High priority threshold.
     * 
     */
    static final ThresholdParameter HIGH = new ThresholdParameter( "High", Detector.HIGH_PRIORITY );

    /**
     * Normal priority threshold.
     * 
     */
    static final ThresholdParameter NORMAL = new ThresholdParameter( "Normal", Detector.NORMAL_PRIORITY );

    /**
     * Low priority threshold.
     * 
     */
    static final ThresholdParameter LOW = new ThresholdParameter( "Low", Detector.LOW_PRIORITY );

    /**
     * Experimental priority threshold.
     * 
     */
    static final ThresholdParameter EXP = new ThresholdParameter( "Exp", Detector.EXP_PRIORITY );

    /**
     * ??? priority threshold.
     * 
     */
    static final ThresholdParameter IGNORE = new ThresholdParameter( "Ignore", Detector.IGNORE_PRIORITY );

    /**
     * Default priority threshold.
     * 
     */
    static final ThresholdParameter DEFAULT = ThresholdParameter.LOW;

    /**
     * The threshold value.
     * 
     */
    private final int value;

    /**
     * The threshold name.
     * 
     */
    private final String name;

    /**
     * Hide default constructor.
     * 
     */
    private ThresholdParameter()
    {
        super();

        this.value = -1;
        this.name = null;
    }

    /**
     * Default constructor.
     * 
     * @param pName
     *            The threshold name to set.
     * @param pValue
     *            The threshold value to set.
     */
    private ThresholdParameter( final String pName, final int pValue )
    {
        super();
        if ( ( pName == null ) || ( pName.trim().length() == 0 ) )
        {
            throw new IllegalArgumentException( "Argument pName not allowed to be null or empty" );
        }
        this.value = pValue;
        this.name = pName;
    }

    /**
     * @return The threshold value.
     */
    public int getValue()
    {
        return this.value;
    }

    /**
     * @return The threshold name.
     */
    public String getName()
    {
        return this.name;
    }
}