Class VersionInfo

java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.types.DataType
net.sf.antcontrib.cpptasks.VersionInfo
All Implemented Interfaces:
Cloneable

public final class VersionInfo extends org.apache.tools.ant.types.DataType
Version Information. This information is applied in a platform specific manner to embed version information into executable images. This behavior is new and subject to change. On the Microsoft Windows platform, a resource is generated and added to the set of files to be compiled. A resource compiler must be specified to compile the generated file. On Unix platforms, versioninfo is currently not used. Future versions may append fileversion to the output file name, use compatibility version for -soname and possibly create symbolic links.
  • Field Details

    • ifCond

      private String ifCond
      if property.
    • unlessCond

      private String unlessCond
      unless property.
    • extendsRef

      private org.apache.tools.ant.types.Reference extendsRef
      extends property.
    • fileVersion

      private String fileVersion
      file version.
    • productVersion

      private String productVersion
      Product version.
    • language

      private String language
      file language.
    • fileComments

      private String fileComments
      comments.
    • companyName

      private String companyName
      Company name.
    • fileDescription

      private String fileDescription
      Description.
    • internalName

      private String internalName
      internal name.
    • legalCopyright

      private String legalCopyright
      legal copyright.
    • legalTrademarks

      private String legalTrademarks
      legal trademark.
    • originalFilename

      private String originalFilename
      original filename.
    • privateBuild

      private String privateBuild
      private build.
    • productName

      private String productName
      product name.
    • specialBuild

      private String specialBuild
      Special build
    • compatibilityVersion

      private String compatibilityVersion
      compatibility version
    • prerelease

      private Boolean prerelease
      prerease build.
    • patched

      private Boolean patched
      prerease build.
  • Constructor Details

    • VersionInfo

      public VersionInfo()
      Constructor.
    • VersionInfo

      private VersionInfo(Vector stack)
      Private constructor for merge.
      Parameters:
      stack - list of version infos with most significant first.
  • Method Details

    • merge

      public VersionInfo merge()
      Returns a VersionInfo that reflects any inherited version information.
      Returns:
      merged version information.
    • execute

      public void execute() throws org.apache.tools.ant.BuildException
      Methods is required for documentation generation, throws exception if called.
      Throws:
      org.apache.tools.ant.BuildException - if called
    • isActive

      public final boolean isActive() throws org.apache.tools.ant.BuildException
      Returns true if the define's if and unless conditions (if any) are satisfied.
      Throws:
      org.apache.tools.ant.BuildException - throws build exception if name is not set
    • setId

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

      public org.apache.tools.ant.types.Reference getExtends()
    • setExtends

      public void setExtends(org.apache.tools.ant.types.Reference extendsRef) throws org.apache.tools.ant.BuildException
      Specifies that this element extends the element with id attribute with a matching value. The configuration will be constructed from the settings of this element, element referenced by extends, and the containing cc element.
      Parameters:
      extendsRef - Reference to the extended processor definition.
      Throws:
      org.apache.tools.ant.BuildException - if this processor definition is a reference
    • getIf

      public final String getIf()
      Gets if property name.
      Returns:
      property name, may be null.
    • setIf

      public final void setIf(String propName)
      Sets the property name for the 'if' condition. The define will be ignored unless the property is defined. The value of the property is insignificant, but values that would imply misinterpretation ("false", "no") will throw an exception when evaluated.
      Parameters:
      propName - property name
    • setRefid

      public void setRefid(org.apache.tools.ant.types.Reference r) throws org.apache.tools.ant.BuildException
      Specifies that this element should behave as if the content of the element with the matching id attribute was inserted at this location. If specified, no other attributes should be specified.
      Overrides:
      setRefid in class org.apache.tools.ant.types.DataType
      Throws:
      org.apache.tools.ant.BuildException
    • getUnless

      public final String getUnless()
      Gets if property name.
      Returns:
      property name, may be null.
    • setUnless

      public final void setUnless(String propName)
      Set the property name for the 'unless' condition. If named property is set, the define will be ignored. The value of the property is insignificant, but values that would imply misinterpretation ("false", "no") of the behavior will throw an exception when evaluated.
      Parameters:
      propName - name of property
    • getFileversion

      public String getFileversion()
      Gets file version.
      Returns:
      file version, may be null.
    • getProductversion

      public String getProductversion()
      Gets Product version.
      Returns:
      product version, may be null
    • getCompatibilityversion

      public String getCompatibilityversion()
      Gets compatibility version.
      Returns:
      compatibility version, may be null
    • getLanguage

      public String getLanguage()
      Gets file language, should be an IETF RFC 3066 identifier, for example, en-US.
      Returns:
      language, may be null.
    • getFilecomments

      public String getFilecomments()
      Gets comments.
      Returns:
      comments, may be null.
    • getCompanyname

      public String getCompanyname()
      Gets Company name.
      Returns:
      company name, may be null.
    • getFiledescription

      public String getFiledescription()
      Gets Description.
      Returns:
      description, may be null.
    • getInternalname

      public String getInternalname()
      Gets internal name.
      Returns:
      internal name, may be null.
    • getLegalcopyright

      public String getLegalcopyright()
      Gets legal copyright.
      Returns:
      legal copyright, may be null.
    • getLegaltrademarks

      public String getLegaltrademarks()
      Gets legal trademark.
      Returns:
      legal trademark, may be null;
    • getOriginalfilename

      public String getOriginalfilename()
      Gets original filename.
      Returns:
      original filename, may be null.
    • getPrivatebuild

      public String getPrivatebuild()
      Gets private build.
      Returns:
      private build, may be null.
    • getPrerelease

      public Boolean getPrerelease()
      Gets prerelease.
      Returns:
      prerelease, may be null.
    • getPatched

      public Boolean getPatched()
      Gets patched.
      Returns:
      patched, may be null.
    • getProductname

      public String getProductname()
      Gets product name.
      Returns:
      product name, may be null.
    • getSpecialbuild

      public String getSpecialbuild()
      Special build
      Returns:
      special build, may be null.
    • setFileversion

      public void setFileversion(String value) throws org.apache.tools.ant.BuildException
      Sets file version.
      Parameters:
      value - new value
      Throws:
      org.apache.tools.ant.BuildException - if specified with refid
    • setProductversion

      public void setProductversion(String value) throws org.apache.tools.ant.BuildException
      Sets product version.
      Parameters:
      value - new value
      Throws:
      org.apache.tools.ant.BuildException - if specified with refid
    • setCompatibilityversion

      public void setCompatibilityversion(String value) throws org.apache.tools.ant.BuildException
      Sets compatibility version.
      Parameters:
      value - new value
      Throws:
      org.apache.tools.ant.BuildException - if specified with refid
    • setLanguage

      public void setLanguage(String value) throws org.apache.tools.ant.BuildException
      Sets language.
      Parameters:
      value - new value, should be an IETF RFC 3066 language identifier.
      Throws:
      org.apache.tools.ant.BuildException - if specified with refid
    • setFilecomments

      public void setFilecomments(String value) throws org.apache.tools.ant.BuildException
      Sets comments.
      Parameters:
      value - new value
      Throws:
      org.apache.tools.ant.BuildException - if specified with refid
    • setFiledescription

      public void setFiledescription(String value)
      Sets file description.
      Parameters:
      value - new value
    • setCompanyname

      public void setCompanyname(String value) throws org.apache.tools.ant.BuildException
      Sets company name.
      Parameters:
      value - new value
      Throws:
      org.apache.tools.ant.BuildException - if specified with refid
    • setInternalname

      public void setInternalname(String value) throws org.apache.tools.ant.BuildException
      Sets internal name. Internal name will automatically be specified from build step, only set this value if intentionally overriding that value.
      Parameters:
      value - new value
      Throws:
      org.apache.tools.ant.BuildException - if specified with refid
    • setLegalcopyright

      public void setLegalcopyright(String value) throws org.apache.tools.ant.BuildException
      Sets legal copyright.
      Parameters:
      value - new value
      Throws:
      org.apache.tools.ant.BuildException - if specified with refid
    • setLegaltrademarks

      public void setLegaltrademarks(String value) throws org.apache.tools.ant.BuildException
      Sets legal trademark.
      Parameters:
      value - new value
      Throws:
      org.apache.tools.ant.BuildException - if specified with refid
    • setOriginalfilename

      public void setOriginalfilename(String value) throws org.apache.tools.ant.BuildException
      Sets original name. Only set this value if intentionally overriding the value from the build set.
      Parameters:
      value - new value
      Throws:
      org.apache.tools.ant.BuildException - if specified with refid
    • setPrivatebuild

      public void setPrivatebuild(String value) throws org.apache.tools.ant.BuildException
      Sets private build.
      Parameters:
      value - new value
      Throws:
      org.apache.tools.ant.BuildException - if specified with refid
    • setPrerelease

      public void setPrerelease(boolean value) throws org.apache.tools.ant.BuildException
      Sets prerelease.
      Parameters:
      value - new value
      Throws:
      org.apache.tools.ant.BuildException - if specified with refid
    • setPatched

      public void setPatched(boolean value) throws org.apache.tools.ant.BuildException
      Sets prerelease.
      Parameters:
      value - new value
      Throws:
      org.apache.tools.ant.BuildException - if specified with refid
    • setProductname

      public void setProductname(String value) throws org.apache.tools.ant.BuildException
      Sets product name.
      Parameters:
      value - new value
      Throws:
      org.apache.tools.ant.BuildException - if specified with refid
    • setSpecialbuild

      public void setSpecialbuild(String value) throws org.apache.tools.ant.BuildException
      Sets private build.
      Parameters:
      value - new value
      Throws:
      org.apache.tools.ant.BuildException - if specified with refid