Skip navigation links
org.apache.tools.ant.taskdefs

Class Apt

  • All Implemented Interfaces:
    java.lang.Cloneable, SelectorContainer

    public class Apt
extends Javac
    Apt Task for running the Annotation processing tool for JDK 1.5. It derives from the existing Javac task, and forces the compiler based on whether we're executing internally, or externally.
    Since:
    Ant 1.7

    • Field Detail

      • EXECUTABLE_NAME

        public static final java.lang.String EXECUTABLE_NAME
        The name of the apt tool.
        See Also:
        Constant Field Values

      • ERROR_IGNORING_COMPILER_OPTION

        public static final java.lang.String ERROR_IGNORING_COMPILER_OPTION
        An warning message when ignoring compiler attribute.
        See Also:
        Constant Field Values

      • ERROR_WRONG_JAVA_VERSION

        public static final java.lang.String ERROR_WRONG_JAVA_VERSION
        A warning message if used with java < 1.5.
        See Also:
        Constant Field Values

      • WARNING_IGNORING_FORK

        public static final java.lang.String WARNING_IGNORING_FORK
        exposed for debug messages
        See Also:
        Constant Field Values

    • Constructor Detail

      • Apt

        public Apt()
        Constructor for Apt task. This sets the apt compiler adapter as the compiler in the super class.

    • Method Detail

      • getAptExecutable

        public java.lang.String getAptExecutable()
        Get the name of the apt executable.
        Returns:
        the name of the executable.

      • setCompiler

        public void setCompiler(java.lang.String compiler)
        Set the compiler. This is not allowed and a warning log message is made.
        Overrides:
        setCompiler in class Javac
        Parameters:
        compiler - not used.

      • setFork

        public void setFork(boolean fork)
        Set the fork attribute. Non-forking APT is highly classpath dependent and appears to be too brittle to work. The sole reason this attribute is retained is the superclass does it
        Overrides:
        setFork in class Javac
        Parameters:
        fork - if false; warn the option is ignored.

      • isCompile

        public boolean isCompile()
        Get the compile option for the apt compiler. If this is false the "-nocompile" argument will be used.
        Returns:
        the value of the compile option.

      • setCompile

        public void setCompile(boolean compile)
        Set the compile option for the apt compiler. Default value is true.
        Parameters:
        compile - if true set the compile option.

      • getFactory

        public java.lang.String getFactory()
        Get the factory option for the apt compiler. If this is non-null the "-factory" argument will be used.
        Returns:
        the value of the factory option.

      • setFactory

        public void setFactory(java.lang.String factory)
        Set the factory option for the apt compiler. Default value is null.
        Parameters:
        factory - the classname of the factory.

      • setFactoryPathRef

        public void setFactoryPathRef(Reference ref)
        Add a reference to a path to the factoryPath attribute.
        Parameters:
        ref - a reference to a path.

      • createFactoryPath

        public Path createFactoryPath()
        Add a path to the factoryPath attribute.
        Returns:
        a path to be configured.

      • getFactoryPath

        public Path getFactoryPath()
        Get the factory path attribute. If this is not null, the "-factorypath" argument will be used. The default value is null.
        Returns:
        the factory path attribute.

      • createOption

        public Apt.Option createOption()
        Create a nested option.
        Returns:
        an option to be configured.

      • getOptions

        public java.util.Vector<Apt.Option> getOptions()
        Get the options to the compiler. Each option will use '"-E" name ["=" value]' argument.
        Returns:
        the options.

      • getPreprocessDir

        public java.io.File getPreprocessDir()
        Get the preprocessdir attribute. This corresponds to the "-s" argument. The default value is null.
        Returns:
        the preprocessdir attribute.

      • setPreprocessDir

        public void setPreprocessDir(java.io.File preprocessDir)
        Set the preprocessdir attribute.
        Parameters:
        preprocessDir - where to place processor generated source files.
Skip navigation links