net.sf.antcontrib.cpptasks

Class TargetDef


public final class TargetDef
extends DataType

Information on the execution platforms for the generated code. (Non-functional prototype)

Constructor Summary

TargetDef()
Constructor.

Method Summary

void
execute()
Bogus method required for documentation generation.
ArchEnum
getArch()
Gets arch.
CPUEnum
getCpu()
Gets cpu.
OSFamilyEnum
getOsfamily()
Gets operating system family.
boolean
isActive()
Returns true if the define's if and unless conditions (if any) are satisfied.
void
setArch(ArchEnum value)
Sets cpu architecture, compiler may use cpu specific instructions.
void
setCpu(CPUEnum value)
Sets preferred cpu, but does not use cpu specific instructions.
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)
Sets the property name for the 'if' condition.
void
setOsfamily(OSFamilyEnum value)
Sets operating system family.
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
setUnless(String propName)
Set the property name for the 'unless' condition.

Constructor Details

TargetDef

public TargetDef()
Constructor.

Method Details

execute

public void execute()
Bogus method required for documentation generation.

getArch

public ArchEnum getArch()
Gets arch.
Returns:
arch, may be null.

getCpu

public CPUEnum getCpu()
Gets cpu.
Returns:
cpu, may be null.

getOsfamily

public OSFamilyEnum getOsfamily()
Gets operating system family.
Returns:
os family, may be null.

isActive

public boolean isActive()
Returns true if the define's if and unless conditions (if any) are satisfied.
Returns:
true if active

setArch

public void setArch(ArchEnum value)
Sets cpu architecture, compiler may use cpu specific instructions.
Parameters:
value - new value

setCpu

public void setCpu(CPUEnum value)
Sets preferred cpu, but does not use cpu specific instructions.
Parameters:
value - new value

setDescription

public void setDescription(String desc)
Sets a description of the current data type.
Parameters:
desc - description

setId

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

setIf

public 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

setOsfamily

public void setOsfamily(OSFamilyEnum value)
Sets operating system family.
Parameters:
value - new value

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.
Parameters:
r - id of referenced target

setUnless

public 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

Copyright B) 2001-2006 Ant-Contrib project. All Rights Reserved.