edu.umd.cs.findbugs.config.AnalysisFeatureSetting Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spotbugs Show documentation

SpotBugs: Because it's easy!

There is a newer version: 4.8.6

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

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

/**
 * Configure a specific boolean analysis property.
 *
 * @author David Hovemeyer
 */
public class AnalysisFeatureSetting {
    private @AnalysisFeature final int property;

    private final boolean enabled;

    /**
     * Constructor.
     *
     * @param property
     *            the analysis property to configure
     * @param enabled
     *            true if the property is enabled, false if not
     */
    public AnalysisFeatureSetting(@AnalysisFeature int property, boolean enabled) {
        this.property = property;
        this.enabled = enabled;
    }

    /**
     * Set the configured value of the analysis property in the given
     * AnalysisContext.
     *
     * @param analysisContext
     *            the AnalysisContext
     */
    public void configure(AnalysisContext analysisContext) {
        analysisContext.setBoolProperty(property, enabled);
    }
}