Class PrecompileDef

  • All Implemented Interfaces:
    java.lang.Cloneable

    public final class PrecompileDef
    extends org.apache.tools.ant.types.DataType
    An element that specifies a prototype file and rules for source files that should not use precompiled headers
    Author:
    Curt Arnold
    • Field Summary

      • Fields inherited from class org.apache.tools.ant.types.DataType

        checked, ref
      • Fields inherited from class org.apache.tools.ant.ProjectComponent

        description, location, project
    • Constructor Summary

      Constructors 
      Constructor Description
      PrecompileDef()
      Constructor
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void appendExceptFileSet​(ConditionalFileSet exceptSet)
      Method used by PrecompileExceptDef to add exception set to PrecompileDef.
      PrecompileExceptDef createExcept()
      Adds filesets that specify files that should not be processed with precompiled headers enabled.
      void execute()  
      java.lang.String[] getExceptFiles()  
      java.io.File getPrototype()
      Gets prototype source file
      boolean isActive()  
      void setDescription​(java.lang.String desc)
      Sets a description of the current data type.
      void setId​(java.lang.String id)
      Sets an id that can be used to reference this element.
      void setIf​(java.lang.String propName)
      Set the 'if' condition.
      void setPrototype​(java.io.File prototype)
      Sets file to precompile.
      void setRefid​(org.apache.tools.ant.types.Reference ref)
      Specifies that this element should behave as if the content of the element with the matching id attribute was inserted at this location.
      void setUnless​(java.lang.String propName)
      Set the 'unless' condition.
      • Methods inherited from class org.apache.tools.ant.types.DataType

        checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes, toString
      • Methods inherited from class org.apache.tools.ant.ProjectComponent

        getDescription, getLocation, getProject, log, log, setLocation, setProject
      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • PrecompileDef

        public PrecompileDef()
        Constructor
    • Method Detail

      • appendExceptFileSet

        public void appendExceptFileSet​(ConditionalFileSet exceptSet)
        Method used by PrecompileExceptDef to add exception set to PrecompileDef.
      • createExcept

        public PrecompileExceptDef createExcept()
        Adds filesets that specify files that should not be processed with precompiled headers enabled.
      • execute

        public void execute()
                     throws org.apache.tools.ant.BuildException
        Throws:
        org.apache.tools.ant.BuildException
      • getExceptFiles

        public java.lang.String[] getExceptFiles()
      • getPrototype

        public java.io.File getPrototype()
        Gets prototype source file
      • isActive

        public boolean isActive()
      • setDescription

        public void setDescription​(java.lang.String desc)
        Sets a description of the current data type.
        Overrides:
        setDescription in class org.apache.tools.ant.ProjectComponent
      • setId

        public void setId​(java.lang.String id)
        Sets an id that can be used to reference this element.
        Parameters:
        id - id
      • setIf

        public void setIf​(java.lang.String propName)
        Set the 'if' condition. The processor will be ignored unless the property is defined. The value of property is insignificant, but values that would imply misinterpretation ("false", "no") will throw an exception when isActive() is evaluated.
        Parameters:
        propName - name of property
      • setPrototype

        public void setPrototype​(java.io.File prototype)
        Sets file to precompile. Should be a source file that includes only one unguarded header file. Default value is "stdafx.cpp".
        Parameters:
        prototype - file path for prototype source file
      • setRefid

        public void setRefid​(org.apache.tools.ant.types.Reference ref)
        Specifies that this element should behave as if the content of the element with the matching id attribute was inserted at this location.
        Overrides:
        setRefid in class org.apache.tools.ant.types.DataType
        Parameters:
        ref - Reference to other element
      • setUnless

        public void setUnless​(java.lang.String propName)
        Set the 'unless' condition. If named property exists at execution time, the processor will be ignored. Value of property is insignificant, but values that would imply misinterpretation ("false", "no") of the behavior will throw an exception when isActive is called.
        Parameters:
        propName - name of property