net.sf.antcontrib.cpptasks

Class PrecompileDef

public final class PrecompileDef extends DataType

An element that specifies a prototype file and rules for source files that should not use precompiled headers

Author: Curt Arnold

Constructor Summary
	PrecompileDef() Constructor

Method Summary
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()
String[]	getExceptFiles()
File	getPrototype() Gets prototype source file
boolean	isActive()
void	setDescription(String desc) Sets a description of the current data type.
void	setId(String id) Sets an id that can be used to reference this element.
void	setIf(String propName) Set the 'if' condition.
void	setPrototype(File prototype) Sets file to precompile.
void	setRefid(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(String propName) Set the 'unless' condition.

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.

getPrototype

public File getPrototype()

Gets prototype source file

setDescription

public void setDescription(String desc)

Sets a description of the current data type.

setId

public void setId(String id)

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

Parameters: id id

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(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(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.

Parameters: ref Reference to other element

setUnless

public void setUnless(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