org.apache.maven.plugins.checkstyle.exec.CheckstyleResults Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of maven-checkstyle-plugin Show documentation

Generates a report on violations of code style and optionally fails the build if violations are detected.

There is a newer version: 3.6.0

Show newest version

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.maven.plugins.checkstyle.exec;

import java.util.HashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;

import com.puppycrawl.tools.checkstyle.api.AuditEvent;
import com.puppycrawl.tools.checkstyle.api.Configuration;
import com.puppycrawl.tools.checkstyle.api.SeverityLevel;

/**
 * Object holding the references to the CheckstyleResults.
 * TODO: provide fallback to disk based storage if too many results.
 *
 * @author Joakim Erdfelt
 *
 */
public class CheckstyleResults {
    private Map> files;

    private Configuration configuration;

    public CheckstyleResults() {
        files = new HashMap<>();
    }

    public List getFileViolations(String file) {
        List violations;

        if (this.files.containsKey(file)) {
            violations = this.files.get(file);
        } else {
            violations = new LinkedList<>();
            if (file != null) {
                this.files.put(file, violations);
            }
        }

        return violations;
    }

    public void setFileViolations(String file, List violations) {
        if (file != null) {
            this.files.put(file, violations);
        }
    }

    public Map> getFiles() {
        return files;
    }

    public void setFiles(Map> files) {
        this.files = files;
    }

    public int getFileCount() {
        return this.files.size();
    }

    public long getSeverityCount(SeverityLevel level) {
        long count = 0;

        for (List errors : this.files.values()) {
            count = count + getSeverityCount(errors, level);
        }

        return count;
    }

    public long getSeverityCount(String file, SeverityLevel level) {
        long count = 0;

        if (!this.files.containsKey(file)) {
            return count;
        }

        List violations = this.files.get(file);

        count = getSeverityCount(violations, level);

        return count;
    }

    public long getSeverityCount(List violations, SeverityLevel level) {
        long count = 0;

        for (AuditEvent event : violations) {
            if (event.getSeverityLevel().equals(level)) {
                count++;
            }
        }

        return count;
    }

    public Configuration getConfiguration() {
        return configuration;
    }

    public void setConfiguration(Configuration configuration) {
        this.configuration = configuration;
    }
}