org.jvnet.maven.plugin.antrun.GraphDefTask Maven / Gradle / Ivy

Go to download
package org.jvnet.maven.plugin.antrun;

import org.apache.tools.ant.BuildException;

/**
 * Computes a dependency graph by applying a filter, then store it to the current project
 * so that it can be used later with <graphRef> filter.
 *
 * 
 * The name is chosen to match with other xxxDef tasks in Ant, like taskDef, typeDef, etc.
 * 
 * @author Kohsuke Kawaguchi
 */
public class GraphDefTask extends DependencyGraphTask {
    private String id;
    protected GraphFilter filter;

    public void setId(String id) {
        this.id = id;
    }

    /**
     * Adds a {@link GraphFilter} child. Ant will invoke this for each child element given in build script.
     */
    public void add(GraphFilter child) {
        if(filter!=null)
            throw new BuildException("Too many filters are given");
        this.filter = child;
    }

    public void execute() throws BuildException {
        if(id==null)
            throw new BuildException("@id is required");

        getProject().addReference(id,buildGraph(filter));
    }
}