WarningProperty.java

/*
 * FindBugs - Find bugs in Java programs
 * Copyright (C) 2005, University of Maryland
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
package edu.umd.cs.findbugs.props;

/**
 * Interface that all warning property enumerations are expected to implement.
 * 
 * @author David Hovemeyer
 */
public interface WarningProperty {
    /**
     * Get the priority adjustment: i.e., the effect that this warning property
     * is expected to have on the likelihood that the warning is real, benign,
     * or a false positive.
     * 
     * @return the priority adjustment
     */
    public abstract PriorityAdjustment getPriorityAdjustment();

    /**
     * Get the fully qualified name of the property. Should be full class name,
     * ".", followed by the descriptive name of the property.
     * 
     * @return fully qualified name of the property
     */
    public abstract String getName();
}