Package org.apache.openjpa.ant

Class ApplicationIdToolTask

  • All Implemented Interfaces:
    java.lang.Cloneable, org.apache.tools.ant.types.selectors.SelectorContainer
    public class ApplicationIdToolTask
extends AbstractTask

    Executes the application id tool on the specified files. This task can take the following arguments:

    • directory
    • ignoreErrors
    • name
    • suffix
    • token
    It can also take an embedded codeFormat element with attributes for the bean properties of the CodeFormat.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected java.lang.String dirName  
      protected ApplicationIdTool.Flags flags  

      • Fields inherited from class org.apache.tools.ant.taskdefs.MatchingTask

        fileset

      • 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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object createCodeFormat()
      Create the embedded code format element.
      protected void executeOn​(java.lang.String[] files)
      Perform the task action on the given files.
      protected ConfigurationImpl newConfiguration()
      Implement this method to return a configuration object for the product in use.
      void setDirectory​(java.lang.String dirName)
      Set the output directory we want the enhancer to write to.
      void setIgnoreErrors​(boolean ignoreErrors)
      Set whether to ignore errors.
      void setName​(java.lang.String name)
      Set the name of the identity class; with this option you must supply exactly one class to run on.
      void setSuffix​(java.lang.String suffix)
      Set a suffix to append to persistent classes to form their identity class name.
      void setToken​(java.lang.String token)
      Set the token to separate stringified primary key field values.

      • Methods inherited from class org.apache.tools.ant.taskdefs.MatchingTask

        add, addAnd, addContains, addContainsRegexp, addCustom, addDate, addDepend, addDepth, addDifferent, addFilename, addMajority, addModified, addNone, addNot, addOr, addPresent, addSelector, addSize, addType, appendSelector, createExclude, createExcludesFile, createInclude, createIncludesFile, createPatternSet, getDirectoryScanner, getImplicitFileSet, getSelectors, hasSelectors, selectorCount, selectorElements, setCaseSensitive, setDefaultexcludes, setExcludes, setExcludesfile, setFollowSymlinks, setIncludes, setIncludesfile, setProject, XsetIgnore, XsetItems

      • 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

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ApplicationIdToolTask

        public ApplicationIdToolTask()
        Default constructor.

    • Method Detail

      • setDirectory

        public void setDirectory​(java.lang.String dirName)
        Set the output directory we want the enhancer to write to.

      • setIgnoreErrors

        public void setIgnoreErrors​(boolean ignoreErrors)
        Set whether to ignore errors.

      • setName

        public void setName​(java.lang.String name)
        Set the name of the identity class; with this option you must supply exactly one class to run on.

      • setSuffix

        public void setSuffix​(java.lang.String suffix)
        Set a suffix to append to persistent classes to form their identity class name.

      • setToken

        public void setToken​(java.lang.String token)
        Set the token to separate stringified primary key field values.

      • createCodeFormat

        public java.lang.Object createCodeFormat()
        Create the embedded code format element.

      • executeOn

        protected void executeOn​(java.lang.String[] files)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
        Description copied from class: AbstractTask
        Perform the task action on the given files.
        Specified by:
        executeOn in class AbstractTask
        Throws:
        java.io.IOException
        java.lang.ClassNotFoundException