com.cflint.config.CFLintConfiguration Maven / Gradle / Ivy

Go to download

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

A static code analysis tool for ColdFusion (in the spirit of FindBugs and Lint). With CFLint, you are able to analyze your ColdFusion code base for code violations.

There is a newer version: 1.5.0

Show newest version

package com.cflint.config;

import java.util.Collection;

import com.cflint.config.CFLintPluginInfo.PluginInfoRule;
import com.cflint.config.CFLintPluginInfo.PluginInfoRule.PluginMessage;
import com.cflint.plugins.CFLintScanner;

public interface CFLintConfiguration {

    boolean includes(PluginMessage pluginMessage);

    boolean excludes(PluginMessage pluginMessage);

    PluginInfoRule getRuleByClass(Class clazz);

    PluginInfoRule getRuleForPlugin(CFLintScanner plugin);

    void addInclude(PluginMessage pluginMessage);

    void addExclude(PluginMessage pluginMessage);

    Collection getRules();
    
    /**
     * get the property from the configuration.
     * This can be overriden with -DcheckerClass.propertyname=value
     *
     * @param name      the name of the parameter
     * @return          the value of the parameter
     */
    public String getParameter(CFLintScanner linter, final String name);

    public String getParameterNotNull(CFLintScanner linter, final String name);

    public  E getParameter(CFLintScanner linter, final String name, final Class clazz);

    public Object getParameter(final String name);
}