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()
Construct a new instance of the PathConvert task.

Method Summary

void
add(FileNameMapper fileNameMapper)
Add a nested filenamemapper.
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()
Learn whether 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)
Set the name of the property into which the converted path will be placed.
void
setRefid(Reference r)
Add a reference to a Path, FileSet, DirSet, or FileList defined elsewhere.
void
setSetonempty(boolean setonempty)
Set whether the specified property will be set 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"; current platform settings are used by default.

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()
Construct a new instance of the PathConvert task.

Method Details

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()
            throws BuildException
Do the execution.
Overrides:
execute in interface Task
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 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)
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. 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.

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

Copyright © 2000-2006 Apache Software Foundation. All Rights Reserved.