<utility : PathConvert>

Description

Converts path and classpath information to a specific target OS format. The resulting formatted path is placed into the specified property.

Parameters

Attribute Description Type Required?
pathsep Set the default path separator string; defaults to current JVM {@link java.io.File#pathSeparator File.pathSeparator}. String ?
refid Add a reference to a Path, FileSet, DirSet, or FileList defined elsewhere. Reference ?
dirsep Set the default directory separator string; defaults to current JVM {@link java.io.File#separator File.separator}. String ?
setonempty Set whether the specified property will be set if the result is the empty string. boolean ?
property Set the name of the property into which the converted path will be placed. String ?
targetos Set targetos to a platform to one of "windows", "unix", "netware", or "os/2"; current platform settings are used by default. String ["windows", "unix", "netware", "os/2", "tandem"] ?

Parameters accepted as nested elements

<path> ...

This object represents a path as used by CLASSPATH or PATH environment variable.

<sometask>
  <somepath>
    <pathelement location="/path/to/file.jar" />
    <pathelement path="/path/to/file2.jar:/path/to/class2;/path/to/class3" />
    <pathelement location="/path/to/file3.jar" />
    <pathelement location="/path/to/file4.jar" />
  </somepath>
</sometask>

The object implemention sometask must provide a method called createSomepath which returns an instance of Path. Nested path definitions are handled by the Path object and must be labeled pathelement.

The path element takes a parameter path which will be parsed and split into single elements. It will usually be used to define a path from an environment variable.

Attribute Description Type Required
refid Makes this instance in effect a reference to another Path instance.

You must not set another attribute or nest elements inside this element if you make it a reference.

 		Reference ?
path Parses a path definition and creates single PathElements. String ?

<map>

Helper class, holds the nested <map> values. Elements will look like this: <map from="d:" to="/foo"/> When running on windows, the prefix comparison will be case insensitive.
Attribute Description Type Required
from Set the "from" attribute of the map entry. String ?
to Set the replacement text to use when from is matched; required. String ?

<mapper> ...

Element to define a FileNameMapper.
Attribute Description Type Required
classpath Set the classpath to load the FileNameMapper through (attribute). Path ?
classpathref Set the classpath to load the FileNameMapper through via reference (attribute). Reference ?
refid Make this Mapper instance a reference to another Mapper.

You must not set any other attribute if you make it a reference.

 		Reference ?
type Set the type of FileNameMapper to use. String ["identity", "flatten", "glob", "merge", "regexp", "package", "unpackage"] ?
classname Set the class name of the FileNameMapper to use. String ?
from Set the argument to FileNameMapper.setFrom String ?
to Set the argument to FileNameMapper.setTo String ?

Generated with AntDoclet