Package net.ggtools.grand.tasks

Class GrandTask

  • All Implemented Interfaces:
    Cloneable
    public class GrandTask
extends org.apache.tools.ant.Task
    A task to create graphs.
    Author:
    Christophe Labouisse

    • Field Summary

      • Fields inherited from class org.apache.tools.ant.Task

        target, taskName, taskType, wrapper

      • Fields inherited from class org.apache.tools.ant.ProjectComponent

        description, location, project

    • Constructor Summary

      Constructors 
      Constructor Description
      GrandTask()  

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void addFilter​(FilterType filter)
      Add a filter to the task.
      void addProperty​(org.apache.tools.ant.taskdefs.Property p)
      Add a new property to be passed to the graphed project.
      void addPropertyset​(org.apache.tools.ant.types.PropertySet ps)
      Set of properties to pass to the graphed project.
      void execute()
      Method execute.
      void setBuildFile​(File file)
      Sets the buildFile.
      void setInheritAll​(boolean value)
      If true, pass all properties to the new Ant project.
      void setOutput​(File file)
      Sets the output file.
      void setOutputConfigFile​(File propertyFile)
      Set a property file to override the output default configuration.
      void setOutputConfigPrefix​(String propertyPrefix)
      Set a property prefix to override the output default configuration.
      void setProject​(org.apache.tools.ant.Project project)
      Method setProject.
      void setPropertyFile​(File propertyFile)
      Deprecated.
      use setOutputConfigFile(File).
      void setShowGraphName​(boolean show)
      Method setShowGraphName.

      • Methods inherited from class org.apache.tools.ant.Task

        bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

      • Methods inherited from class org.apache.tools.ant.ProjectComponent

        clone, getDescription, getLocation, getProject, setDescription, setLocation

    • Constructor Detail

      • GrandTask

        public GrandTask()

    • Method Detail

      • execute

        public final void execute()
        Method execute.
        Overrides:
        execute in class org.apache.tools.ant.Task
        See Also:
        Task.execute()

      • setProject

        public final void setProject​(org.apache.tools.ant.Project project)
        Method setProject.
        Overrides:
        setProject in class org.apache.tools.ant.ProjectComponent
        Parameters:
        project - Project
        See Also:
        ProjectComponent.setProject(org.apache.tools.ant.Project)

      • setBuildFile

        public final void setBuildFile​(File file)
        Sets the buildFile.
        Parameters:
        file - File

      • setOutput

        public final void setOutput​(File file)
        Sets the output file.
        Parameters:
        file - File

      • setPropertyFile

        @Deprecated
public final void setPropertyFile​(File propertyFile)
        Deprecated.
        use setOutputConfigFile(File).
        Set a property file to override the output default configuration.
        Parameters:
        propertyFile - File

      • setOutputConfigFile

        public final void setOutputConfigFile​(File propertyFile)
        Set a property file to override the output default configuration.
        Parameters:
        propertyFile - File

      • setOutputConfigPrefix

        public final void setOutputConfigPrefix​(String propertyPrefix)
        Set a property prefix to override the output default configuration.
        Parameters:
        propertyPrefix - String

      • setShowGraphName

        public final void setShowGraphName​(boolean show)
        Method setShowGraphName.
        Parameters:
        show - boolean

      • setInheritAll

        public final void setInheritAll​(boolean value)
        If true, pass all properties to the new Ant project. Defaults to true.
        Parameters:
        value - if true pass all properties to the new Ant project.

      • addFilter

        public final void addFilter​(FilterType filter)
        Add a filter to the task.
        Parameters:
        filter - FilterType

      • addProperty

        public final void addProperty​(org.apache.tools.ant.taskdefs.Property p)
        Add a new property to be passed to the graphed project.
        Parameters:
        p - the property to set.

      • addPropertyset

        public final void addPropertyset​(org.apache.tools.ant.types.PropertySet ps)
        Set of properties to pass to the graphed project.
        Parameters:
        ps - property set to add