Package org.apache.tools.ant.taskdefs
Class PathConvert
- java.lang.Object
- 
- org.apache.tools.ant.ProjectComponent
- 
- org.apache.tools.ant.Task
- 
- org.apache.tools.ant.taskdefs.PathConvert
 
 
 
- 
- All Implemented Interfaces:
- java.lang.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 SummaryNested Classes Modifier and Type Class Description classPathConvert.MapEntryHelper class, holds the nested <map> values.static classPathConvert.TargetOsAn enumeration of supported targets: "windows", "unix", "netware", and "os/2".
 - 
Field Summary- 
Fields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
 
- 
 - 
Constructor SummaryConstructors Constructor Description PathConvert()
 - 
Method SummaryModifier and Type Method Description 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.booleanisPreserveDuplicates()Get the preserveDuplicates.booleanisReference()Learn whether the refid attribute of this element been set.voidsetDirSep(java.lang.String sep)Set the default directory separator string; defaults to current JVMFile.separator.voidsetPathSep(java.lang.String sep)Set the default path separator string; defaults to current JVMFile.pathSeparator.voidsetPreserveDuplicates(boolean preserveDuplicates)Set the preserveDuplicates.voidsetProperty(java.lang.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(java.lang.String target)Deprecated.since 1.5.x.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.- 
Methods inherited from class org.apache.tools.ant.TaskbindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType
 - 
Methods inherited from class org.apache.tools.ant.ProjectComponentclone, getDescription, getLocation, getProject, setDescription, setLocation, setProject
 
- 
 
- 
- 
- 
Method Detail- 
createPathpublic Path createPath() Create a nested path element.- Returns:
- a Path to be used by Ant reflection.
 
 - 
addpublic void add(ResourceCollection rc) Add an arbitrary ResourceCollection.- Parameters:
- rc- the ResourceCollection to add.
- Since:
- Ant 1.7
 
 - 
createMappublic PathConvert.MapEntry createMap() Create a nested MAP element.- Returns:
- a Map to configure.
 
 - 
setTargetos@Deprecated public void setTargetos(java.lang.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)
 
 - 
setTargetospublic 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
 
 - 
setSetonemptypublic 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
 
 - 
setPropertypublic void setProperty(java.lang.String p) Set the name of the property into which the converted path will be placed.- Parameters:
- p- the property name.
 
 - 
setRefidpublic 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.
 
 - 
setPathSeppublic void setPathSep(java.lang.String sep) Set the default path separator string; defaults to current JVMFile.pathSeparator.- Parameters:
- sep- path separator string.
 
 - 
setDirSeppublic void setDirSep(java.lang.String sep) Set the default directory separator string; defaults to current JVMFile.separator.- Parameters:
- sep- directory separator string.
 
 - 
setPreserveDuplicatespublic void setPreserveDuplicates(boolean preserveDuplicates) Set the preserveDuplicates.- Parameters:
- preserveDuplicates- the boolean to set
- Since:
- Ant 1.8
 
 - 
isPreserveDuplicatespublic boolean isPreserveDuplicates() Get the preserveDuplicates.- Returns:
- boolean
- Since:
- Ant 1.8
 
 - 
isReferencepublic boolean isReference() Learn whether the refid attribute of this element been set.- Returns:
- true if refid is valid.
 
 - 
executepublic void execute() throws BuildExceptionDo the execution.- Overrides:
- executein class- Task
- Throws:
- BuildException- if something is invalid.
 
 - 
addMapperpublic void addMapper(Mapper mapper) Add a mapper to convert the file names.- Parameters:
- mapper- a- Mappervalue.
 
 - 
addpublic void add(FileNameMapper fileNameMapper) Add a nested filenamemapper.- Parameters:
- fileNameMapper- the mapper to add.
- Since:
- Ant 1.6.3
 
 
- 
 
-