com.cflint.config.CFLintConfig Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of CFLint Show documentation
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.
package com.cflint.config;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import com.cflint.config.CFLintPluginInfo.PluginInfoRule;
import com.cflint.config.CFLintPluginInfo.PluginInfoRule.PluginMessage;
import com.cflint.plugins.CFLintScanner;
import com.fasterxml.jackson.annotation.JsonAnyGetter;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
@XmlRootElement(name = "config")
@JsonIgnoreProperties(ignoreUnknown = true)
public class CFLintConfig extends BaseConfig {
@Deprecated
private List output = new ArrayList<>();
private List rules = new ArrayList<>();
private List excludes = new ArrayList<>();
private List includes = new ArrayList<>();
private HashMap parameters = new HashMap<>();
private boolean inheritParent = true;
@Deprecated
private boolean inheritPlugins = true;
/*
* (non-Javadoc)
*
* @see com.cflint.config.CFLintConfiguration#getOutput()
*/
@Deprecated
public List getOutput() {
return output;
}
@XmlElement(name = "output")
@Deprecated
public void setOutput(final List output) {
System.err.println(
"DEPRECATED: The use of \"output\" have been marked as deprecated in CFLint 1.2.x and support for them will be fully removed in CFLint 1.4.0. Please remove the settings from your configuration file(s). Run CFLint in verbose mode for config file location details.");
this.output = output;
}
public HashMap getParameters() {
return parameters;
}
@JsonAnyGetter
@XmlElement(name = "parameters")
public void setParameters(final HashMap parameters) {
this.parameters = parameters;
}
/*
* (non-Javadoc)
*
* @see com.cflint.config.CFLintConfiguration#getRules()
*/
@Override
public List getRules() {
return rules;
}
@XmlElement(name = "rule")
public void setRules(final List rules) {
this.rules = rules;
}
/*
* (non-Javadoc)
*
* @see com.cflint.config.CFLintConfiguration#getExcludes()
*/
public List getExcludes() {
return excludes;
}
@XmlElement(name = "excludes")
public void setExcludes(final List excludes) {
this.excludes = excludes;
}
/*
* (non-Javadoc)
*
* @see com.cflint.config.CFLintConfiguration#getIncludes()
*/
public List getIncludes() {
return includes;
}
@XmlElement(name = "includes")
public void setIncludes(final List includes) {
this.includes = includes;
}
public boolean isInheritParent() {
return inheritParent;
}
@XmlAttribute(name = "inheritParent")
public void setInheritParent(final boolean inheritParent) {
this.inheritParent = inheritParent;
}
@Deprecated
public boolean isInheritPlugins() {
return inheritPlugins;
}
@XmlAttribute(name = "inheritPlugins")
@Deprecated
public void setInheritPlugins(final boolean inheritPlugins) {
// #315 --- inheritPlugins can not be overwritten to false in 1.2.0 --- will be fully removed in 1.4.0 (but will then break people's setup if the setting remains in .cflintrc or the xml config
System.err.println(
"DEPRECATED: The use of \"inheritPlugins\" have been marked as deprecated in CFLint 1.2.x and support for them will be fully removed in CFLint 1.4.0. Please remove the settings from your configuration file(s). Run CFLint in verbose mode for config file location details.");
this.inheritPlugins = true;
}
public static class ConfigOutput {
private String name;
private OutputText text;
private OutputXML html;
private OutputXML xml;
private OutputText json;
public String getName() {
return name;
}
@XmlAttribute(name = "name")
public void setName(final String name) {
this.name = name;
}
public OutputText getText() {
return text;
}
public OutputText getJSON() {
return json;
}
@XmlElement(name = "text")
public void setText(final OutputText text) {
this.text = text;
}
@XmlElement(name = "json")
public void setJSON(final OutputText json) {
this.json = json;
}
public OutputXML getHtml() {
return html;
}
@XmlElement(name = "html")
public void setHtml(final OutputXML html) {
this.html = html;
}
public OutputXML getXml() {
return xml;
}
@XmlElement(name = "xml")
public void setXml(final OutputXML xml) {
this.xml = xml;
}
public static class OutputText {
private String file;
public String getFile() {
return file;
}
@XmlAttribute(name = "file")
public void setFile(final String file) {
this.file = file;
}
}
public static class OutputXML extends OutputText {
private String style;
public String getStyle() {
return style;
}
@XmlAttribute(name = "style")
public void setStyle(final String style) {
this.style = style;
}
}
}
/*
* (non-Javadoc)
*
* @see com.cflint.config.CFLintConfiguration#includes(com.cflint.config.
* CFLintPluginInfo.PluginInfoRule.PluginMessage)
*/
@Override
public boolean includes(PluginMessage pluginMessage) {
return (getIncludes().isEmpty() || getIncludes().contains(pluginMessage));
}
/*
* (non-Javadoc)
*
* @see com.cflint.config.CFLintConfiguration#excludes(com.cflint.config.
* CFLintPluginInfo.PluginInfoRule.PluginMessage)
*/
@Override
public boolean excludes(PluginMessage pluginMessage) {
return (!getExcludes().isEmpty() && getExcludes().contains(pluginMessage));
}
/*
* (non-Javadoc)
*
* @see
* com.cflint.config.CFLintConfiguration#getRuleByClass(java.lang.Class)
*/
@Override
public PluginInfoRule getRuleByClass(final Class clazz) {
final String className = clazz.getSimpleName();
for (final PluginInfoRule rule : getRules()) {
if (rule.getName().equals(className) || className.equals(rule.getClassName())) {
return rule;
}
}
return null;
}
/*
* (non-Javadoc)
*
* @see
* com.cflint.config.CFLintConfiguration#getRuleForPlugin(com.cflint.plugins
* .CFLintScanner)
*/
@Override
public PluginInfoRule getRuleForPlugin(final CFLintScanner plugin) {
for (final PluginInfoRule rule : getRules()) {
if (rule.getPluginInstance() == plugin) {
return rule;
}
}
return getRuleByClass(plugin.getClass());
}
@Override
public void addInclude(PluginMessage pluginMessage) {
includes.add(pluginMessage);
}
@Override
public void addExclude(PluginMessage pluginMessage) {
excludes.add(pluginMessage);
}
public static CFLintConfiguration createDefault() {
final CFLintPluginInfo pluginInfo = ConfigUtils.loadDefaultPluginInfo();
CFLintConfig defaultConfig = new CFLintConfig();
defaultConfig.setRules(pluginInfo.getRules());
return defaultConfig;
}
@Override
public Object getParameter(String name) {
if(parameters!=null && name !=null && parameters.containsKey(name)){
return parameters.get(name);
}
return null;
}
}