Class PathConvert

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.tools.ant.taskdefs.PathConvert

All Implemented Interfaces:

Cloneable

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

Nested Classes

Modifier and Type	Class	Description
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 Task

target, taskName, taskType, wrapper

Modifier and Type	Field	Description
protected Target	target	Deprecated. since 1.6.x.
protected String	taskName	Deprecated. since 1.6.x.
protected String	taskType	Deprecated. since 1.6.x.
protected RuntimeConfigurable	wrapper	Deprecated. since 1.6.x.

Fields inherited from class ProjectComponent

description, location, project

Modifier and Type	Field	Description
protected String	description	Deprecated. since 1.6.x.
protected Location	location	Deprecated. since 1.6.x.
protected Project	project	Deprecated. since 1.6.x.

Constructor Summary

Constructors

Constructor	Description
PathConvert()

Method Summary

Modifier and Type	Method	Description
void	add(ResourceCollection rc)	Add an arbitrary ResourceCollection.
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	isPreserveDuplicates()	Get the preserveDuplicates.
boolean	isReference()	Learn whether the refid attribute of this element been set.
void	setDest(Resource dest)	Set destination resource.
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	setPreserveDuplicates(boolean preserveDuplicates)	Set the preserveDuplicates.
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. since 1.5.x.
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 Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Modifier and Type	Method	Description
final void	bindToOwner(Task owner)	Bind a task to another; use this when configuring a newly created task to do work on behalf of another.
Target	getOwningTarget()	Returns the container target of this task.
RuntimeConfigurable	getRuntimeConfigurableWrapper()	Returns the wrapper used for runtime configuration.
String	getTaskName()	Returns the name to use in logging messages.
String	getTaskType()	Return the type of task.
protected RuntimeConfigurable	getWrapper()	Return the runtime configurable structure for this task.
protected void	handleErrorFlush(String output)	Handles an error line by logging it with the WARN priority.
protected void	handleErrorOutput(String output)	Handles an error output by logging it with the WARN priority.
protected void	handleFlush(String output)	Handles output by logging it with the INFO priority.
protected int	handleInput(byte[] buffer, int offset, int length)	Handle an input request by this task.
protected void	handleOutput(String output)	Handles output by logging it with the INFO priority.
void	init()	Called by the project to let the task initialize properly.
protected final boolean	isInvalid()	Has this task been marked invalid?
void	log(String msg)	Logs a message with the default (INFO) priority.
void	log(String msg, int msgLevel)	Logs a message with the given priority.
void	log(String msg, Throwable t, int msgLevel)	Logs a message with the given priority.
void	log(Throwable t, int msgLevel)	Logs a message with the given priority.
void	maybeConfigure()	Configures this task - if it hasn't been done already.
final void	perform()	Performs this task if it's still valid, or gets a replacement version and performs that otherwise.
void	reconfigure()	Force the task to be reconfigured from its RuntimeConfigurable.
void	setOwningTarget(Target target)	Sets the target container of this task.
void	setRuntimeConfigurableWrapper(RuntimeConfigurable wrapper)	Sets the wrapper to be used for runtime configuration.
void	setTaskName(String name)	Sets the name to use in logging messages.
void	setTaskType(String type)	Sets the name with which the task has been invoked.

Methods inherited from class ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Modifier and Type	Method	Description
Object	clone()
String	getDescription()	Returns the description of the current action.
Location	getLocation()	Returns the file/location where this task was defined.
Project	getProject()	Returns the project to which this component belongs.
void	setDescription(String desc)	Sets a description of the current action.
void	setLocation(Location location)	Sets the file/location where this task was defined.
void	setProject(Project project)	Sets the project object of this component.

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

PathConvert

public PathConvert()

Method Details

createPath

public Path createPath()

Create a nested path element.

Returns:

a Path to be used by Ant reflection.

add

public void add(ResourceCollection rc)

Add an arbitrary ResourceCollection.

Parameters:

rc - the ResourceCollection to add.

Since:

Ant 1.7

createMap

public PathConvert.MapEntry createMap()

Create a nested MAP element.

Returns:

a Map to configure.

setTargetos

@Deprecated
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(PathConvert.TargetOs)

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

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

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.

setPathSep

public void setPathSep(String sep)

Set the default path separator string; defaults to current JVM File.pathSeparator.

Parameters:

sep - path separator string.

setDirSep

public void setDirSep(String sep)

Set the default directory separator string; defaults to current JVM File.separator.

Parameters:

sep - directory separator string.

setPreserveDuplicates

public void setPreserveDuplicates(boolean preserveDuplicates)

Set the preserveDuplicates.

Parameters:

preserveDuplicates - the boolean to set

Since:

Ant 1.8

isPreserveDuplicates

public boolean isPreserveDuplicates()

Get the preserveDuplicates.

Returns:

boolean

Since:

Ant 1.8

isReference

public boolean isReference()

Learn whether the refid attribute of this element been set.

Returns:

true if refid is valid.

setDest

public void setDest(Resource dest)

Set destination resource.

Parameters:

dest -

Since:

Ant 1.10.13

execute

public void execute()
             throws BuildException

Do the execution.

Overrides:

execute in class Task

Throws:

BuildException - if something is invalid.

addMapper

public void addMapper(Mapper mapper)

Add a mapper to convert the file names.

Parameters:

mapper - a Mapper value.

add

public void add(FileNameMapper fileNameMapper)

Add a nested filenamemapper.

Parameters:

fileNameMapper - the mapper to add.

Since:

Ant 1.6.3