net.sf.antcontrib.cpptasks

Class DistributerDef


public final class DistributerDef
extends DataType

Distributed build information (Non-functional prototype).

Constructor Summary

DistributerDef()
Constructor.

Method Summary

DistributerMap
createMap()
Local to remote filename maps.
void
execute()
Required by documentation generator.
String
getHosts()
Gets hosts.
DistributerProtocolEnum
getProtocol()
Gets protocol.
int
getTcpcork()
Gets tcp cork.
boolean
isActive()
Returns true if the if and unless conditions (if any) are satisfied.
void
setHosts(String value)
Sets hosts.
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
setProtocol(DistributerProtocolEnum value)
Sets protocol.
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
setTcpcork(int value)
Sets TCP_CORK value.
void
setUnless(String propName)
Set the property name for the 'unless' condition.
void
setUser(String value)
Sets remote user name.

Constructor Details

DistributerDef

public DistributerDef()
Constructor.

Method Details

createMap

public DistributerMap createMap()
Local to remote filename maps.
Returns:
new map

execute

public void execute()
Required by documentation generator.

getHosts

public String getHosts()
Gets hosts.
Returns:
hosts, may be null.

getProtocol

public DistributerProtocolEnum getProtocol()
Gets protocol.
Returns:
protocol, may be null.

getTcpcork

public int getTcpcork()
Gets tcp cork.
Returns:
TCP_CORK value.

isActive

public boolean isActive()
Returns true if the if and unless conditions (if any) are satisfied.
Returns:
true if definition is active.

setHosts

public void setHosts(String value)
Sets hosts.
Parameters:
value - new value

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

setProtocol

public void setProtocol(DistributerProtocolEnum value)
Sets protocol.
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 - reference name

setTcpcork

public void setTcpcork(int value)
Sets TCP_CORK value.
Parameters:
value - new value

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

setUser

public void setUser(String value)
Sets remote user name.
Parameters:
value - user name

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