net.sf.antcontrib.cpptasks

Class DistributerMap


public final class DistributerMap
extends DataType

Local to remote filename mapping (Experimental).

Constructor Summary

DistributerMap()
Constructor.

Method Summary

void
execute()
Required by documentation generator.
File
getLocal()
Gets local directory.
String
getRemote()
Gets remote name for directory.
boolean
isActive()
Returns true if the if and unless conditions (if any) are satisfied.
void
setHosts(String value)
Sets hosts for which this mapping is valid.
void
setIf(String propName)
Sets the property name for the 'if' condition.
void
setLocal(File value)
Sets local directory for base of mapping.
void
setRemote(String value)
Sets remote name for directory.
void
setRemoteSeparator(String value)
Sets the separator character (/ or \) for the remote system.
void
setUnless(String propName)
Set the property name for the 'unless' condition.
String
toRemote(String host, File localFile)
Converts the local file name to the remote name for the same file.

Constructor Details

DistributerMap

public DistributerMap()
Constructor.

Method Details

execute

public void execute()
Required by documentation generator.

getLocal

public File getLocal()
Gets local directory.
Returns:
local directory, may be null.

getRemote

public String getRemote()
Gets remote name for directory.
Returns:
remote name, may be null.

isActive

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

setHosts

public void setHosts(String value)
Sets hosts for which this mapping is valid.
Parameters:
value - hosts

setIf

public void setIf(String propName)
Sets the property name for the 'if' condition. This object 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

setLocal

public void setLocal(File value)
Sets local directory for base of mapping.
Parameters:
value - value

setRemote

public void setRemote(String value)
Sets remote name for directory.
Parameters:
value - remote name for directory

setRemoteSeparator

public void setRemoteSeparator(String value)
Sets the separator character (/ or \) for the remote system.
Parameters:
value - separator character

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

toRemote

public String toRemote(String host,
                       File localFile)
Converts the local file name to the remote name for the same file.
Parameters:
host - host
localFile - local file
Returns:
remote name for local file, null if unknown.

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