Class EnhancerTask

java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.Java
org.datanucleus.enhancer.EnhancerTask
All Implemented Interfaces:
Cloneable
public class EnhancerTask extends org.apache.tools.ant.taskdefs.Java
Enhancer Ant Task.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private File
    dir
     
    (package private) List<org.apache.tools.ant.types.FileSet>
    filesets
    Filesets of metadata files or class files to be enhanced.
    private String
    fileSuffixes
    The suffixes of the files to use.
    private String
    ifpropertyset
    Only runs this task if the property is set.

    Fields inherited from class org.apache.tools.ant.taskdefs.Java

    redirector, redirectorElement

    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
    EnhancerTask()
    Default constructor

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addFileSet(org.apache.tools.ant.types.FileSet fs)
    Add a fileset.
    void
    execute()
    Execution method
    File
    getDir()
    Gets the root dir for looking for files
    private org.apache.tools.ant.DirectoryScanner
    getDirectoryScanner(File dir)
     
    protected File[]
    getFiles()
     
    void
    setAlwaysDetachable(boolean detachable)
    set always detachable.
    void
    setApi(String api)
    set API Adapter
    void
    setCheckonly(boolean checkonly)
    Whether to just check the enhancement state
    void
    setDestination(File destdir)
    set output directory
    void
    setDetachListener(boolean flag)
    Whether to use detach listener.
    void
    setDir(File dir)
    Sets the root dir for looking for files
    void
    setFileSuffixes(String suffixes)
    Set one or more file suffixes for the input files.
    void
    setGenerateConstructor(boolean flag)
    Whether to allow generation of default constructor where required.
    void
    setGeneratePK(boolean flag)
    Whether to allow generation of PKs where required.
    void
    setIf(String ifpropertyset)
     
    void
    setPersistenceUnit(String unit)
    Set the persistence-unit name to enhance
    void
    setQuiet(boolean quiet)
    set quiet
    void
    setVerbose(boolean verbose)
    set verbose

    Methods inherited from class org.apache.tools.ant.taskdefs.Java

    addAssertions, addConfiguredRedirector, addEnv, addSysproperty, addSyspropertyset, checkConfiguration, clearArgs, createArg, createBootclasspath, createClasspath, createJvmarg, createModulepath, createPermissions, createUpgrademodulepath, createWatchdog, executeJava, executeJava, getCommandLine, getSysProperties, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, maybeSetResultPropertyValue, run, setAppend, setArgs, setClassname, setClasspath, setClasspathRef, setCloneVm, setDiscardError, setDiscardOutput, setError, setErrorProperty, setFailonerror, setFork, setInput, setInputString, setJar, setJvm, setJvmargs, setJVMVersion, setLogError, setMaxmemory, setModule, setModulepath, setModulepathRef, setNewenvironment, setOutput, setOutputproperty, setResultProperty, setSourceFile, setSpawn, setTimeout, setupRedirector

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

    bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, 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, setProject

    Methods inherited from class Object

    equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

    • dir

      private File dir

    • ifpropertyset

      private String ifpropertyset
      Only runs this task if the property is set.

    • fileSuffixes

      private String fileSuffixes
      The suffixes of the files to use. Defaults to files suffixed "jdo".

    • filesets

      List<org.apache.tools.ant.types.FileSet> filesets
      Filesets of metadata files or class files to be enhanced.

  • Constructor Details

    • EnhancerTask

      public EnhancerTask()
      Default constructor

  • Method Details

    • execute

      public void execute() throws org.apache.tools.ant.BuildException
      Execution method
      Overrides:
      execute in class org.apache.tools.ant.taskdefs.Java
      Throws:
      org.apache.tools.ant.BuildException - Thrown when an error occurs when processing the task

    • setCheckonly

      public void setCheckonly(boolean checkonly)
      Whether to just check the enhancement state
      Parameters:
      checkonly - Whether to just check

    • setGeneratePK

      public void setGeneratePK(boolean flag)
      Whether to allow generation of PKs where required.
      Parameters:
      flag - Allow PK generation

    • setGenerateConstructor

      public void setGenerateConstructor(boolean flag)
      Whether to allow generation of default constructor where required.
      Parameters:
      flag - Allow default constructor addition

    • setDetachListener

      public void setDetachListener(boolean flag)
      Whether to use detach listener.
      Parameters:
      flag - to detach listener use

    • getDirectoryScanner

      private org.apache.tools.ant.DirectoryScanner getDirectoryScanner(File dir)

    • setDestination

      public void setDestination(File destdir)
      set output directory
      Parameters:
      destdir - output dir

    • setApi

      public void setApi(String api)
      set API Adapter
      Parameters:
      api - API Adapter

    • setPersistenceUnit

      public void setPersistenceUnit(String unit)
      Set the persistence-unit name to enhance
      Parameters:
      unit - Name of the persistence-unit to enhance

    • setDir

      public void setDir(File dir)
      Sets the root dir for looking for files
      Overrides:
      setDir in class org.apache.tools.ant.taskdefs.Java
      Parameters:
      dir - the root dir

    • getDir

      public File getDir()
      Gets the root dir for looking for files
      Returns:
      the root dir

    • setFileSuffixes

      public void setFileSuffixes(String suffixes)
      Set one or more file suffixes for the input files. Suffixes are separated with a comma(,)
      Parameters:
      suffixes - the suffices

    • setAlwaysDetachable

      public void setAlwaysDetachable(boolean detachable)
      set always detachable.
      Parameters:
      detachable - Whether all enhanced classes should be detachable

    • setVerbose

      public void setVerbose(boolean verbose)
      set verbose
      Parameters:
      verbose - Whether to give verbose output

    • setQuiet

      public void setQuiet(boolean quiet)
      set quiet
      Parameters:
      quiet - Whether to give no output

    • addFileSet

      public void addFileSet(org.apache.tools.ant.types.FileSet fs)
      Add a fileset. @see ant manual
      Parameters:
      fs - the FileSet

    • getFiles

      protected File[] getFiles()

    • setIf

      public void setIf(String ifpropertyset)