findbugsanalysisfeatures.java

A static analysis tool to find bugs in Java programs

/*
 * 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;

import edu.umd.cs.findbugs.ba.AnalysisContext;
import edu.umd.cs.findbugs.ba.AnalysisFeatures;

/**
 * Boolean-valued analysis properties for FindBugs.
 * 
 * @see edu.umd.cs.findbugs.ba.AnalysisContext#setBoolProperty(int, boolean)
 * @see edu.umd.cs.findbugs.ba.AnalysisContext#getBoolProperty(int)
 * @author David Hovemeyer
 */
public abstract class FindBugsAnalysisFeatures {
	private static final int START;
	 static {
		 START = AnalysisFeatures.NUM_BOOLEAN_ANALYSIS_PROPERTIES;
	 }

	/**
	 * "Relaxed" warning reporting mode.
	 * Rather than using hard-coded heuristics to decide when
	 * to suppress a warning, report warnings freely and
	 * encode the heuristics as BugProperties (for consumption
	 * by a machine-learning-based ranking algorithm).
	 */
	public static final int RELAXED_REPORTING_MODE = START + 0;

	/**
	 * Enable interprocedural analysis.
	 */
	public static final int INTERPROCEDURAL_ANALYSIS = START + 1;
	public static final int INTERPROCEDURAL_ANALYSIS_OF_REFERENCED_CLASSES = START + 2;

	static void setProperty(int property, boolean value) {
		AnalysisContext.currentAnalysisContext().setBoolProperty(property, value);
	}

	static boolean getProperty(int property) {
		return AnalysisContext.currentAnalysisContext().getBoolProperty(property);
	}

	/**
	 * Set relaxed reporting mode.
	 * 
	 * @param relaxedMode true if relaxed reporting mode should be enabled, false if not
	 */
	public static void setRelaxedMode(boolean relaxedMode) {
		setProperty(RELAXED_REPORTING_MODE, relaxedMode);
	}


	/**
	 * Get relaxed reporting mode.
	 * 
	 * @return true if relaxed reporting mode should be enabled, false if not
	 */
	public static boolean isRelaxedMode() {
		return getProperty(RELAXED_REPORTING_MODE);
	}
}