net.kemitix.dependency.digraph.maven.plugin.DependencyData Maven / Gradle / Ivy

Go to download

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

Generates a DOT Digraph of dependencies between packages within a project

There is a newer version: 0.9.1

Show newest version

package net.kemitix.dependency.digraph.maven.plugin;

import org.apache.maven.plugin.logging.Log;

import net.kemitix.node.Node;

/**
 * Interface for storing package and class dependency data.
 *
 * @author pcampbell
 */
interface DependencyData {

    /**
     * Records a dependency between the user class and the imported class.
     *
     * @param user     the package that is using the import
     * @param imported the package that contains the class that is being
     *                 imported
     */
    void addDependency(String user, String imported);

    /**
     * Sets the base package.
     *
     * @param basePackage the base package within which to report
     */
    void setBasePackage(final String basePackage);

    /**
     * Returns the base node.
     *
     * @return the base node
     */
    Node getBaseNode();

    /**
     * Log the statue of the dependency data.
     *
     * @param log the log to send the output
     */
    void debugLog(Log log);

}