+DistributerMap (cpptasks 1.0b5 API) +

From 683d490074d93baa8a47db7ec43b7bd31145a12a Mon Sep 17 00:00:00 2001 From: Mark Donszelmann Date: Thu, 5 Nov 2009 23:00:15 +0100 Subject: Tar file expanded and committed --- .../net/sf/antcontrib/cpptasks/DistributerMap.html | 535 +++++++++++++++++++++ 1 file changed, 535 insertions(+) create mode 100644 site/apidocs/net/sf/antcontrib/cpptasks/DistributerMap.html (limited to 'site/apidocs/net/sf/antcontrib/cpptasks/DistributerMap.html') diff --git a/site/apidocs/net/sf/antcontrib/cpptasks/DistributerMap.html b/site/apidocs/net/sf/antcontrib/cpptasks/DistributerMap.html new file mode 100644 index 0000000..293361e --- /dev/null +++ b/site/apidocs/net/sf/antcontrib/cpptasks/DistributerMap.html @@ -0,0 +1,535 @@ + + + + + + + +DistributerMap (cpptasks 1.0b5 API) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+ + + + + + + + + + + + +

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

+ +

+ PREV CLASS + NEXT CLASS

+ FRAMES + NO FRAMES + + + + +

+ SUMMARY: NESTED | FIELD | CONSTR | METHOD

+DETAIL: FIELD | CONSTR | METHOD

+ + + +

+ +

+ +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
+

public final class DistributerMap
extends org.apache.tools.ant.types.DataType
extends org.apache.tools.ant.types.DataType

+ + +

+Local to remote filename mapping (Experimental). +

+ +

+ + + + + + + +
+Field Summary
+ + + + + + + + +
Fields inherited from class org.apache.tools.ant.types.DataType
checked, description, ref
+ + + + + + + + +
Fields inherited from class org.apache.tools.ant.ProjectComponent
project
+ + + + + + + + + + + +
+Constructor Summary
DistributerMap() + +
+          Constructor.
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ void execute() + +
+          Required by documentation generator.
+ java.io.File getLocal() + +
+          Gets local directory.
+ java.lang.String getRemote() + +
+          Gets remote name for directory.
+ boolean isActive() + +
+          Returns true if the if and unless conditions (if any) are + satisfied.
+ void setHosts(java.lang.String value) + +
+          Sets hosts for which this mapping is valid.
+ void setIf(java.lang.String propName) + +
+          Sets the property name for the 'if' condition.
+ void setLocal(java.io.File value) + +
+          Sets local directory for base of mapping.
+ void setRemote(java.lang.String value) + +
+          Sets remote name for directory.
+ void setRemoteSeparator(java.lang.String value) + +
+          Sets the separator character (/ or \) for the remote system.
+ void setUnless(java.lang.String propName) + +
+          Set the property name for the 'unless' condition.
+ java.lang.String toRemote(java.lang.String host, + java.io.File localFile) + +
+          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, dieOnCircularReference, getCheckedRef, getDescription, getRefid, isChecked, isReference, noChildrenAllowed, setChecked, setDescription, setRefid, tooManyAttributes
+ + + + + + + + +
Methods inherited from class org.apache.tools.ant.ProjectComponent
getProject, log, log, setProject
+ + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+ +

Fields inherited from class org.apache.tools.ant.types.DataType
`checked, description, ref`

Fields inherited from class org.apache.tools.ant.ProjectComponent
`project`

+Constructor Summary
`DistributerMap()` + + + Constructor.

+Method Summary
+ `void`	`execute()` + + + Required by documentation generator.
+ `java.io.File`	`getLocal()` + + + Gets local directory.
+ `java.lang.String`	`getRemote()` + + + Gets remote name for directory.
+ `boolean`	`isActive()` + + + Returns true if the if and unless conditions (if any) are + satisfied.
+ `void`	`setHosts(java.lang.String value)` + + + Sets hosts for which this mapping is valid.
+ `void`	`setIf(java.lang.String propName)` + + + Sets the property name for the 'if' condition.
+ `void`	`setLocal(java.io.File value)` + + + Sets local directory for base of mapping.
+ `void`	`setRemote(java.lang.String value)` + + + Sets remote name for directory.
+ `void`	`setRemoteSeparator(java.lang.String value)` + + + Sets the separator character (/ or \) for the remote system.
+ `void`	`setUnless(java.lang.String propName)` + + + Set the property name for the 'unless' condition.
+ `java.lang.String`	`toRemote(java.lang.String host, + java.io.File localFile)` + + + 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, dieOnCircularReference, getCheckedRef, getDescription, getRefid, isChecked, isReference, noChildrenAllowed, setChecked, setDescription, setRefid, tooManyAttributes`

Methods inherited from class org.apache.tools.ant.ProjectComponent
`getProject, log, log, setProject`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

+ + + + + + + + +
+Constructor Detail
+ +

+DistributerMap

+public DistributerMap()

Constructor. +

+ + + + + + + + +

+Method Detail

+ +

+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

+public void setIf(java.lang.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

+ +

+setUnless

+public void setUnless(java.lang.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

+ +

+getLocal

+public java.io.File getLocal()

Gets local directory. +

Returns:: local directory, may be null.

+ +

+getRemote

+public java.lang.String getRemote()

Gets remote name for directory. +

Returns:: remote name, may be null.

+ +

+toRemote

+public java.lang.String toRemote(java.lang.String host,
+                                 java.io.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.

+ +

+setLocal

+public void setLocal(java.io.File value)

Sets local directory for base of mapping. +

Parameters:: value - value

+ +

+setRemote

+public void setRemote(java.lang.String value)

Sets remote name for directory. +

Parameters:: value - remote name for directory

+ +

+setRemoteSeparator

+public void setRemoteSeparator(java.lang.String value)

Sets the separator character (/ or \) for the remote system. +

Parameters:: value - separator character

+ +

+setHosts

+public void setHosts(java.lang.String value)

Sets hosts for which this mapping is valid. +

Parameters:: value - hosts

+ +

+ + + + + + + + + + + + + + + + + + + +