net.sf.sanity4j.model.coverage.PackageCoverage Maven / Gradle / Ivy

Go to download

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

Sanity4J was created to simplify running multiple static code analysis tools on the Java projects. It provides a single entry point to run all the selected tools and produce a consolidated report, which presents all findings in an easily accessible manner.

There is a newer version: 1.1.1

Show newest version

package net.sf.sanity4j.model.coverage; 

import java.util.HashMap;
import java.util.Map;

/** 
 * PackageCoverage - Coverage information for a package.
 * 
 * @author Yiannis Paschalidis 
 * @since Sanity4J 1.0
 */
public class PackageCoverage extends AbstractCoverage
{
    /** The package name. */
    private final String packageName;
    
    /** ClassCoverages in this package, keyed by name. */
    private final Map classesByName = new HashMap();
    
    /**
     * Creates a PackageCoverage.
     * @param packageName the package name.
     */
    public PackageCoverage(final String packageName)
    {
        this.packageName = packageName;
    }

    /**.
     * @return the package name
     */
    public String getPackageName()
    {
        return packageName;
    }
    
    /**
     * Retrieves the coverage information for the given class.
     *  
     * @param className the fully qualified class name.
     * @return the coverage for the given class, or null if there isn't any.
     */
    public ClassCoverage getClassCoverage(final String className)
    {
        return classesByName.get(className);
    }
    
    /**
     * Adds class coverage.
     * @param coverage the class coverage to add.
     */
    public void addClass(final ClassCoverage coverage)
    {
        classesByName.put(coverage.getClassName(), coverage);
    }    

    /**
     * @return the number of classes in this package.
     */
    public int getClassCount()
    {
        return classesByName.size();
    }
    
    /**
     * @return the number of executable lines in this package.
     */
    public int getLineCount()
    {
        int count = 0;
        
        for (ClassCoverage coverage : classesByName.values())
        {
            count += coverage.getLineCount();
        }
        
        return count;
    }
    
    /**
     * @return the number of covered lines in this package.
     */
    public int getCoveredLineCount()
    {
        int count = 0;
        
        for (ClassCoverage coverage : classesByName.values())
        {
            count += coverage.getCoveredLineCount();
        }
        
        return count;
    }
    
    /**
     * @return the number of branches in this package.
     */
    public int getBranchCount()
    {
        int count = 0;
        
        for (ClassCoverage coverage : classesByName.values())
        {
            count += coverage.getBranchCount();
        }
        
        return count;
    }
    
    /**
     * @return the number of covered branches in this package.
     */
    public int getCoveredBranchCount()
    {
        int count = 0;
        
        for (ClassCoverage coverage : classesByName.values())
        {
            count += coverage.getCoveredBranchCount();
        }
        
        return count;
    }        
}