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.
execute
public void execute()
throws org.apache.tools.ant.BuildException
Methods is required for documentation generation, throws
exception if called.
getCompanyname
public String getCompanyname()
Gets Company name.
- company name, may be null.
getCompatibilityversion
public String getCompatibilityversion()
Gets compatibility version.
- compatibility version, may be null
getExtends
public Reference getExtends()
getFilecomments
public String getFilecomments()
Gets comments.
getFiledescription
public String getFiledescription()
Gets Description.
- description, may be null.
getFileversion
public String getFileversion()
Gets file version.
- file version, may be null.
getIf
public final String getIf()
Gets if property name.
- property name, may be null.
getInternalname
public String getInternalname()
Gets internal name.
- internal name, may be null.
getLanguage
public String getLanguage()
Gets file language, should be an IETF RFC 3066 identifier, for example, en-US.
getLegalcopyright
public String getLegalcopyright()
Gets legal copyright.
- legal copyright, may be null.
getLegaltrademarks
public String getLegaltrademarks()
Gets legal trademark.
- legal trademark, may be null;
getOriginalfilename
public String getOriginalfilename()
Gets original filename.
- original filename, may be null.
getPatched
public Boolean getPatched()
Gets patched.
getPrerelease
public Boolean getPrerelease()
Gets prerelease.
getPrivatebuild
public String getPrivatebuild()
Gets private build.
- private build, may be null.
getProductname
public String getProductname()
Gets product name.
- product name, may be null.
getProductversion
public String getProductversion()
Gets Product version.
- product version, may be null
getSpecialbuild
public String getSpecialbuild()
Special build
- special build, may be null.
getUnless
public final String getUnless()
Gets if property name.
- property name, may be null.
isActive
public final boolean isActive()
throws BuildException
Returns true if the define's if and unless conditions (if any) are
satisfied.
merge
public VersionInfo merge()
Returns a VersionInfo that reflects the state of
setCompanyname
public void setCompanyname(String value)
throws BuildException
Sets company name.
setCompatibilityversion
public void setCompatibilityversion(String value)
throws BuildException
Sets compatibility version.
setExtends
public void setExtends(Reference extendsRef)
throws 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.
extendsRef
- Reference to the extended processor definition.
setFilecomments
public void setFilecomments(String value)
throws BuildException
Sets comments.
setFiledescription
public void setFiledescription(String value)
Sets file description.
setFileversion
public void setFileversion(String value)
throws BuildException
Sets file version.
setId
public void setId(String id)
Sets an id that can be used to reference this element.
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.
setInternalname
public void setInternalname(String value)
throws BuildException
Sets internal name. Internal name will automatically be
specified from build step, only set this value if
intentionally overriding that value.
setLanguage
public void setLanguage(String value)
throws BuildException
Sets language.
value
- new value, should be an IETF RFC 3066 language identifier.
setLegalcopyright
public void setLegalcopyright(String value)
throws BuildException
Sets legal copyright.
setLegaltrademarks
public void setLegaltrademarks(String value)
throws BuildException
Sets legal trademark.
setOriginalfilename
public void setOriginalfilename(String value)
throws BuildException
Sets original name. Only set this value if
intentionally overriding the value from the build set.
setPatched
public void setPatched(boolean value)
throws BuildException
Sets prerelease.
setPrerelease
public void setPrerelease(boolean value)
throws BuildException
Sets prerelease.
setPrivatebuild
public void setPrivatebuild(String value)
throws BuildException
Sets private build.
setProductname
public void setProductname(String value)
throws BuildException
Sets product name.
setProductversion
public void setProductversion(String value)
throws BuildException
Sets product version.
setRefid
public void setRefid(Reference r)
throws 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.
setSpecialbuild
public void setSpecialbuild(String value)
throws BuildException
Sets private build.
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.
propName
- name of property