| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.tools.ant.ProjectComponent
org.apache.tools.ant.Task
org.apache.tools.ant.taskdefs.PathConvert
public class PathConvert
Converts path and classpath information to a specific target OS format. The resulting formatted path is placed into the specified property.
| Nested Class Summary | |
|---|---|
|  class | PathConvert.MapEntryHelper class, holds the nested <map> values. | 
| static class | PathConvert.TargetOsAn enumeration of supported targets: "windows", "unix", "netware", and "os/2". | 
| Field Summary | 
|---|
| Fields inherited from class org.apache.tools.ant.Task | 
|---|
| target, taskName, taskType, wrapper | 
| Fields inherited from class org.apache.tools.ant.ProjectComponent | 
|---|
| description, location, project | 
| Constructor Summary | |
|---|---|
| PathConvert()Construct a new instance of the PathConvert task. | |
| Method Summary | |
|---|---|
|  void | add(FileNameMapper fileNameMapper)Add a nested filenamemapper. | 
|  void | add(ResourceCollection rc)Add an arbitrary ResourceCollection. | 
|  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 | setDirSep(java.lang.String sep)Set the default directory separator string; defaults to current JVM File.separator. | 
|  void | setPathSep(java.lang.String sep)Set the default path separator string; defaults to current JVM File.pathSeparator. | 
|  void | setPreserveDuplicates(boolean preserveDuplicates)Set the preserveDuplicates. | 
|  void | setProperty(java.lang.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(PathConvert.TargetOs target)Set targetos to a platform to one of "windows", "unix", "netware", or "os/2"; current platform settings are used by default. | 
|  void | setTargetos(java.lang.String target)Deprecated. since 1.5.x. Use the method taking a TargetOs argument instead. | 
| Methods inherited from class org.apache.tools.ant.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 | 
| Methods inherited from class org.apache.tools.ant.ProjectComponent | 
|---|
| clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject | 
| Methods inherited from class java.lang.Object | 
|---|
| equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Constructor Detail | 
|---|
public PathConvert()
| Method Detail | 
|---|
public Path createPath()
public void add(ResourceCollection rc)
rc - the ResourceCollection to add.public PathConvert.MapEntry createMap()
public void setTargetos(java.lang.String target)
target - the target os.setTargetos(PathConvert.TargetOs)public void setTargetos(PathConvert.TargetOs target)
target - the target ospublic void setSetonempty(boolean setonempty)
setonempty - true or false.public void setProperty(java.lang.String p)
p - the property name.public void setRefid(Reference r)
r - the reference to a path, fileset, dirset or filelist.public void setPathSep(java.lang.String sep)
File.pathSeparator.
sep - path separator string.public void setDirSep(java.lang.String sep)
File.separator.
sep - directory separator string.public void setPreserveDuplicates(boolean preserveDuplicates)
preserveDuplicates - the boolean to setpublic boolean isPreserveDuplicates()
public boolean isReference()
public void execute()
             throws BuildException
execute in class TaskBuildException - if something is invalid.public void addMapper(Mapper mapper)
mapper - a Mapper value.public void add(FileNameMapper fileNameMapper)
fileNameMapper - the mapper to add.| 
 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||