Package net.sf.antcontrib.cpptasks
Class DistributerMap
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.types.DataType
net.sf.antcontrib.cpptasks.DistributerMap
- All Implemented Interfaces:
Cloneable
public final class DistributerMap
extends org.apache.tools.ant.types.DataType
Local to remote filename mapping (Experimental).
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate String
Canonical local file name.private String
hosts that for which this map is valid.private String
if property.private File
local directory name.private String
remote name.private char
Separator (/ or \) character on remote system.private String
unless property.Fields inherited from class org.apache.tools.ant.types.DataType
checked, ref
Fields inherited from class org.apache.tools.ant.ProjectComponent
description, location, project
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
execute()
Required by documentation generator.getLocal()
Gets local directory.Gets remote name for directory.boolean
isActive()
Returns true if the if and unless conditions (if any) are satisfied.void
Sets hosts for which this mapping is valid.void
Sets the property name for the 'if' condition.void
Sets local directory for base of mapping.void
Sets remote name for directory.void
setRemoteSeparator
(String value) Sets the separator character (/ or \) for the remote system.void
Set the property name for the 'unless' condition.Converts the local file name to the remote name for the same file.Methods inherited from class org.apache.tools.ant.types.DataType
checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString
Methods inherited from class org.apache.tools.ant.ProjectComponent
getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
-
Field Details
-
ifCond
if property. -
unlessCond
unless property. -
localName
local directory name. -
canonicalPath
Canonical local file name. -
remoteName
remote name. -
remoteSeparator
private char remoteSeparatorSeparator (/ or \) character on remote system. -
hosts
hosts that for which this map is valid.
-
-
Constructor Details
-
DistributerMap
public DistributerMap()Constructor.
-
-
Method Details
-
execute
public void execute()Required by documentation generator. -
isActive
public boolean isActive()Returns true if the if and unless conditions (if any) are satisfied.- Returns:
- true if this object is active.
-
setIf
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
-
setUnless
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
-
getLocal
Gets local directory.- Returns:
- local directory, may be null.
-
getRemote
Gets remote name for directory.- Returns:
- remote name, may be null.
-
toRemote
Converts the local file name to the remote name for the same file.- Parameters:
host
- hostlocalFile
- local file- Returns:
- remote name for local file, null if unknown.
-
setLocal
Sets local directory for base of mapping.- Parameters:
value
- value
-
setRemote
Sets remote name for directory.- Parameters:
value
- remote name for directory
-
setRemoteSeparator
Sets the separator character (/ or \) for the remote system.- Parameters:
value
- separator character
-
setHosts
Sets hosts for which this mapping is valid.- Parameters:
value
- hosts
-