org.apache.tools.ant.taskdefs

Class PathConvert

public class PathConvert extends Task

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

Since: Ant 1.4

UNKNOWN: category="utility"

Nested Class Summary
classPathConvert.MapEntry
Helper class, holds the nested <map> values.
static classPathConvert.TargetOs
An enumeration of supported targets: "windows", "unix", "netware", and "os/2".
Constructor Summary
PathConvert()
Construct a new instance of the PathConvert task.
Method Summary
voidadd(ResourceCollection rc)
Add an arbitrary ResourceCollection.
voidadd(FileNameMapper fileNameMapper)
Add a nested filenamemapper.
voidaddMapper(Mapper mapper)
Add a mapper to convert the file names.
PathConvert.MapEntrycreateMap()
Create a nested MAP element.
PathcreatePath()
Create a nested path element.
voidexecute()
Do the execution.
booleanisReference()
Learn whether the refid attribute of this element been set.
voidsetDirSep(String sep)
Set the default directory separator string; defaults to current JVM {@link java.io.File#separator File.separator}.
voidsetPathSep(String sep)
Set the default path separator string; defaults to current JVM {@link java.io.File#pathSeparator File.pathSeparator}.
voidsetProperty(String p)
Set the name of the property into which the converted path will be placed.
voidsetRefid(Reference r)
Add a reference to a Path, FileSet, DirSet, or FileList defined elsewhere.
voidsetSetonempty(boolean setonempty)
Set whether the specified property will be set if the result is the empty string.
voidsetTargetos(String target)
Set targetos to a platform to one of "windows", "unix", "netware", or "os/2"; current platform settings are used by default.
voidsetTargetos(PathConvert.TargetOs target)
Set targetos to a platform to one of "windows", "unix", "netware", or "os/2"; current platform settings are used by default.

Constructor Detail

PathConvert

public PathConvert()
Construct a new instance of the PathConvert task.

Method Detail

add

public void add(ResourceCollection rc)
Add an arbitrary ResourceCollection.

Parameters: rc the ResourceCollection to add.

Since: Ant 1.7

add

public void add(FileNameMapper fileNameMapper)
Add a nested filenamemapper.

Parameters: fileNameMapper the mapper to add.

Since: Ant 1.6.3

addMapper

public void addMapper(Mapper mapper)
Add a mapper to convert the file names.

Parameters: mapper a Mapper value.

createMap

public PathConvert.MapEntry createMap()
Create a nested MAP element.

Returns: a Map to configure.

createPath

public Path createPath()
Create a nested path element.

Returns: a Path to be used by Ant reflection.

execute

public void execute()
Do the execution.

Throws: BuildException if something is invalid.

isReference

public boolean isReference()
Learn whether the refid attribute of this element been set.

Returns: true if refid is valid.

setDirSep

public void setDirSep(String sep)
Set the default directory separator string; defaults to current JVM {@link java.io.File#separator File.separator}.

Parameters: sep directory separator string.

setPathSep

public void setPathSep(String sep)
Set the default path separator string; defaults to current JVM {@link java.io.File#pathSeparator File.pathSeparator}.

Parameters: sep path separator string.

setProperty

public void setProperty(String p)
Set the name of the property into which the converted path will be placed.

Parameters: p the property name.

setRefid

public void setRefid(Reference r)
Add a reference to a Path, FileSet, DirSet, or FileList defined elsewhere.

Parameters: r the reference to a path, fileset, dirset or filelist.

setSetonempty

public void setSetonempty(boolean setonempty)
Set whether the specified property will be set if the result is the empty string.

Parameters: setonempty true or false.

Since: Ant 1.5

setTargetos

public void setTargetos(String target)

Deprecated: since 1.5.x. Use the method taking a TargetOs argument instead.

Set targetos to a platform to one of "windows", "unix", "netware", or "os/2"; current platform settings are used by default.

Parameters: target the target os.

See Also: setTargetos

setTargetos

public void setTargetos(PathConvert.TargetOs target)
Set targetos to a platform to one of "windows", "unix", "netware", or "os/2"; current platform settings are used by default.

Parameters: target the target os

Since: Ant 1.5