org.apache.tools.ant.types
public class Path extends DataType implements Cloneable
<sometask>
<somepath>
<pathelement location="/path/to/file.jar" />
<pathelement path="/path/to/file2.jar:/path/to/class2;/path/to/class3" />
<pathelement location="/path/to/file3.jar" />
<pathelement location="/path/to/file4.jar" />
</somepath>
</sometask>
The object implemention sometask
must provide a method called
createSomepath
which returns an instance of Path
.
Nested path definitions are handled by the Path object and must be labeled
pathelement
.
The path element takes a parameter path
which will be parsed
and split into single elements. It will usually be used
to define a path from an environment variable.
Nested Class Summary | |
---|---|
class | Path.PathElement
Helper class, holds the nested <pathelement> values. |
Field Summary | |
---|---|
static Path | systemBootClasspath
The system bootclassspath as a Path object.
|
static Path | systemClasspath The system classspath as a Path object |
Constructor Summary | |
---|---|
Path(Project p, String path)
Invoked by IntrospectionHelper for setXXX(Path p)
attribute setters. | |
Path(Project project)
Construct an empty Path . |
Method Summary | |
---|---|
void | add(Path path)
Adds a nested path |
void | addDirset(DirSet dset)
Adds a nested <dirset> element. |
void | addExisting(Path source)
Adds the components on the given path which exist to this
Path. |
void | addExisting(Path source, boolean tryUserDir) Same as addExisting, but support classpath behavior if tryUserDir
is true. |
void | addExtdirs(Path extdirs)
Emulation of extdirs feature in java >= 1.2.
|
void | addFilelist(FileList fl)
Adds a nested <filelist> element. |
void | addFileset(FileSet fs)
Adds a nested <fileset> element. |
void | addJavaRuntime()
Add the Java Runtime classes to this Path instance. |
void | append(Path other)
Append the contents of the other Path instance to this. |
Object | clone()
Return a Path that holds the same elements as this instance. |
Path | concatSystemClasspath()
Concatenates the system class path in the order specified by
the ${build.sysclasspath} property - using "last" as
default value. |
Path | concatSystemClasspath(String defValue)
Concatenates the system class path in the order specified by
the ${build.sysclasspath} property - using the supplied value
if ${build.sysclasspath} has not been set. |
Path | createPath()
Creates a nested <path> element. |
Path.PathElement | createPathElement()
Creates the nested <pathelement> element. |
protected void | dieOnCircularReference(Stack stk, Project p)
Overrides the version of DataType to recurse on all DataType
child elements that may have been added. |
String[] | list()
Returns all path elements defined by this and nested path objects. |
void | setLocation(File location)
Adds a element definition to the path. |
void | setPath(String path)
Parses a path definition and creates single PathElements. |
void | setRefid(Reference r)
Makes this instance in effect a reference to another Path instance.
|
int | size()
How many parts does this Path instance consist of. |
String | toString()
Returns a textual representation of the path, which can be used as
CLASSPATH or PATH environment variable definition. |
static String | translateFile(String source)
Returns its argument with all file separator characters
replaced so that they match the local OS conventions. |
protected static boolean | translateFileSep(StringBuffer buffer, int pos)
Translates all occurrences of / or \ to correct separator of the
current platform and returns whether it had to do any
replacements. |
static String[] | translatePath(Project project, String source)
Splits a PATH (with : or ; as separators) into its parts. |
Since: Ant 1.6.2
setXXX(Path p)
attribute setters.Parameters: project the Project
for this path. path the String
path definition.
Path
.Parameters: project the Project
for this path.
Since: Ant 1.6
<dirset>
element.Parameters: source - source path whose components are examined for existence
Parameters: source tryUserDir
Parameters: extdirs - Path to append files to
<filelist>
element.<fileset>
element.<path>
element.<pathelement>
element.Returns: list of path elements.
Parameters: location the location of the element to add (must not be
null
nor empty.
Parameters: path the String
path definition.
You must not set another attribute or nest elements inside this element if you make it a reference.
Returns: a textual representation of the path.