net.sf.antcontrib.cpptasks

Class VersionInfo

public final class VersionInfo extends 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.

Constructor Summary
	VersionInfo() Constructor.

Method Summary
void	execute() Methods is required for documentation generation, throws exception if called.
String	getCompanyname() Gets Company name.
String	getCompatibilityversion() Gets compatibility version.
Reference	getExtends()
String	getFilecomments() Gets comments.
String	getFiledescription() Gets Description.
String	getFileversion() Gets file version.
String	getIf() Gets if property name.
String	getInternalname() Gets internal name.
String	getLanguage() Gets file language, should be an IETF RFC 3066 identifier, for example, en-US.
String	getLegalcopyright() Gets legal copyright.
String	getLegaltrademarks() Gets legal trademark.
String	getOriginalfilename() Gets original filename.
Boolean	getPatched() Gets patched.
Boolean	getPrerelease() Gets prerelease.
String	getPrivatebuild() Gets private build.
String	getProductname() Gets product name.
String	getProductversion() Gets Product version.
String	getSpecialbuild() Special build
String	getUnless() Gets if property name.
boolean	isActive() Returns true if the define's if and unless conditions (if any) are satisfied.
VersionInfo	merge() Returns a VersionInfo that reflects any inherited version information.
void	setCompanyname(String value) Sets company name.
void	setCompatibilityversion(String value) Sets compatibility version.
void	setExtends(Reference extendsRef) Specifies that this element extends the element with id attribute with a matching value.
void	setFilecomments(String value) Sets comments.
void	setFiledescription(String value) Sets file description.
void	setFileversion(String value) Sets file version.
void	setId(String id) Sets an id that can be used to reference this element.
void	setIf(String propName) Sets the property name for the 'if' condition.
void	setInternalname(String value) Sets internal name.
void	setLanguage(String value) Sets language.
void	setLegalcopyright(String value) Sets legal copyright.
void	setLegaltrademarks(String value) Sets legal trademark.
void	setOriginalfilename(String value) Sets original name.
void	setPatched(boolean value) Sets prerelease.
void	setPrerelease(boolean value) Sets prerelease.
void	setPrivatebuild(String value) Sets private build.
void	setProductname(String value) Sets product name.
void	setProductversion(String value) Sets product version.
void	setRefid(Reference r) Specifies that this element should behave as if the content of the element with the matching id attribute was inserted at this location.
void	setSpecialbuild(String value) Sets private build.
void	setUnless(String propName) Set the property name for the 'unless' condition.

Constructor Detail

VersionInfo

public VersionInfo()

Constructor.

Method Detail

execute

public void execute()

Methods is required for documentation generation, throws exception if called.

Throws: org.apache.tools.ant.BuildException if called

getCompanyname

public String getCompanyname()

Gets Company name.

Returns: company name, may be null.

getCompatibilityversion

public String getCompatibilityversion()

Gets compatibility version.

Returns: compatibility version, may be null

getExtends

public Reference getExtends()

getFilecomments

public String getFilecomments()

Gets comments.

Returns: comments, may be null.

getFiledescription

public String getFiledescription()

Gets Description.

Returns: description, may be null.

getFileversion

public String getFileversion()

Gets file version.

Returns: file version, may be null.

getIf

public final String getIf()

Gets if property name.

Returns: property name, may be null.

getInternalname

public String getInternalname()

Gets internal name.

Returns: internal name, 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.

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.

getPatched

public Boolean getPatched()

Gets patched.

Returns: patched, may be null.

getPrerelease

public Boolean getPrerelease()

Gets prerelease.

Returns: prerelease, may be null.

getPrivatebuild

public String getPrivatebuild()

Gets private build.

Returns: private build, may be null.

getProductname

public String getProductname()

Gets product name.

Returns: product name, may be null.

getProductversion

public String getProductversion()

Gets Product version.

Returns: product version, may be null

getSpecialbuild

public String getSpecialbuild()

Special build

Returns: special build, may be null.

getUnless

public final String getUnless()

Gets if property name.

Returns: property name, may be null.

isActive

public final boolean isActive()

Returns true if the define's if and unless conditions (if any) are satisfied.

Throws: BuildException throws build exception if name is not set

merge

public VersionInfo merge()

Returns a VersionInfo that reflects any inherited version information.

Returns: merged version information.

setCompanyname

public void setCompanyname(String value)

Sets company name.

Parameters: value new value

Throws: BuildException if specified with refid

setCompatibilityversion

public void setCompatibilityversion(String value)

Sets compatibility version.

Parameters: value new value

Throws: BuildException if specified with refid

setExtends

public void setExtends(Reference extendsRef)

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: BuildException if this processor definition is a reference

setFilecomments

public void setFilecomments(String value)

Sets comments.

Parameters: value new value

Throws: BuildException if specified with refid

setFiledescription

public void setFiledescription(String value)

Sets file description.

Parameters: value new value

setFileversion

public void setFileversion(String value)

Sets file version.

Parameters: value new value

Throws: BuildException if specified with refid

setId

public void setId(String id)

Sets an id that can be used to reference this element.

Parameters: id id

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

setInternalname

public void setInternalname(String value)

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: BuildException if specified with refid

setLanguage

public void setLanguage(String value)

Sets language.

Parameters: value new value, should be an IETF RFC 3066 language identifier.

Throws: BuildException if specified with refid

setLegalcopyright

public void setLegalcopyright(String value)

Sets legal copyright.

Parameters: value new value

Throws: BuildException if specified with refid

setLegaltrademarks

public void setLegaltrademarks(String value)

Sets legal trademark.

Parameters: value new value

Throws: BuildException if specified with refid

setOriginalfilename

public void setOriginalfilename(String value)

Sets original name. Only set this value if intentionally overriding the value from the build set.

Parameters: value new value

Throws: BuildException if specified with refid

setPatched

public void setPatched(boolean value)

Sets prerelease.

Parameters: value new value

Throws: BuildException if specified with refid

setPrerelease

public void setPrerelease(boolean value)

Sets prerelease.

Parameters: value new value

Throws: BuildException if specified with refid

setPrivatebuild

public void setPrivatebuild(String value)

Sets private build.

Parameters: value new value

Throws: BuildException if specified with refid

setProductname

public void setProductname(String value)

Sets product name.

Parameters: value new value

Throws: BuildException if specified with refid

setProductversion

public void setProductversion(String value)

Sets product version.

Parameters: value new value

Throws: BuildException if specified with refid

setRefid

public void setRefid(Reference r)

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)

Sets private build.

Parameters: value new value

Throws: BuildException if specified with refid

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