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

Nested Class Summary

class
PathConvert.MapEntry
Helper class, holds the nested <map> values.
static class
PathConvert.TargetOs
an enumeration of supported targets: windows", "unix", "netware", and "os/2".

Field Summary

Fields inherited from class org.apache.tools.ant.Task

description, location, target, taskName, taskType, wrapper

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

project

Constructor Summary

PathConvert()
constructor

Method Summary

void
addMapper(Mapper mapper)
Add a mapper to convert the file names.
PathConvert.MapEntry
createMap()
Create a nested MAP element
Path
createPath()
Create a nested PATH element
void
execute()
Do the execution.
boolean
isReference()
Has the refid attribute of this element been set?
void
setDirSep(String sep)
Set the default directory separator string; defaults to current JVM File.separator
void
setPathSep(String sep)
Set the default path separator string; defaults to current JVM File.pathSeparator
void
setProperty(String p)
The property into which the converted path will be placed.
void
setRefid(Reference r)
Adds a reference to a Path, FileSet, DirSet, or FileList defined elsewhere.
void
setSetonempty(boolean setonempty)
Set setonempty If false, don't set the new property if the result is the empty string.
void
setTargetos(String target)
Deprecated. use the method taking a TargetOs argument instead
void
setTargetos(PathConvert.TargetOs target)
Set targetos to a platform to one of "windows", "unix", "netware", or "os/2"; required unless unless pathsep and/or dirsep are specified.

Methods inherited from class org.apache.tools.ant.Task

execute, getDescription, getLocation, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, maybeConfigure, perform, reconfigure, setDescription, setLocation, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

getProject, log, log, setProject

Constructor Details

PathConvert

public PathConvert()
constructor

Method Details

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


execute

public void execute()
            throws BuildException
Do the execution.
Overrides:
execute in interface Task

Throws:
BuildException - if something is invalid


isReference

public boolean isReference()
Has 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 File.separator

Parameters:
sep - directory separator string


setPathSep

public void setPathSep(String sep)
Set the default path separator string; defaults to current JVM File.pathSeparator

Parameters:
sep - path separator string


setProperty

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


setRefid

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


setSetonempty

public void setSetonempty(boolean setonempty)
Set setonempty If false, don't set the new property if the result is the empty string.

Parameters:
setonempty - true or false

Since:
Ant 1.5


setTargetos

public void setTargetos(String target)

Deprecated. use the method taking a TargetOs argument instead

Set targetos to a platform to one of "windows", "unix", "netware", or "os/2". Required unless unless pathsep and/or dirsep are specified.

See Also:
setTargetos(PathConvert.TargetOs)


setTargetos

public void setTargetos(PathConvert.TargetOs target)
Set targetos to a platform to one of "windows", "unix", "netware", or "os/2"; required unless unless pathsep and/or dirsep are specified.

Since:
Ant 1.5


Copyright B) 2000-2005 Apache Software Foundation. All Rights Reserved.