Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.tools.ant.ProjectComponent
org.apache.tools.ant.types.DataType
org.apache.tools.ant.types.Path
<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 |
|
Field Summary | |
static Path |
|
static Path |
|
Fields inherited from class org.apache.tools.ant.types.DataType | |
checked , description , ref |
Fields inherited from class org.apache.tools.ant.ProjectComponent | |
project |
Constructor Summary | |
Method Summary | |
void | |
void | |
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void | |
Object |
|
Path |
|
Path |
|
Path |
|
Path.PathElement |
|
protected void |
|
String[] |
|
void |
|
void |
|
void | |
int |
|
String |
|
static String |
|
protected static boolean |
|
static String[] |
|
Methods inherited from class org.apache.tools.ant.types.DataType | |
checkAttributesAllowed , checkChildrenAllowed , circularReference , dieOnCircularReference , getCheckedRef , getDescription , getRefid , isChecked , isReference , noChildrenAllowed , setChecked , setDescription , setRefid , tooManyAttributes |
Methods inherited from class org.apache.tools.ant.ProjectComponent | |
getProject , log , log , setProject |
public static Path systemBootClasspath
The system bootclassspath as a Path object.
- Since:
- Ant 1.6.2
public Path(Project project)
Construct an emptyPath
.
- Parameters:
project
- theProject
for this path.
public Path(Project p, String path)
Invoked by IntrospectionHelper forsetXXX(Path p)
attribute setters.
- Parameters:
path
- theString
path definition.
public void addExisting(Path source)
Adds the components on the given path which exist to this Path. Components that don't exist, aren't added.
- Parameters:
source
- - source path whose components are examined for existence
public void addExisting(Path source, boolean tryUserDir)
Same as addExisting, but support classpath behavior if tryUserDir is true. Classpaths are relative to user dir, not the project base. That used to break jspc test
- Parameters:
source
-tryUserDir
-
public void addExtdirs(Path extdirs)
Emulation of extdirs feature in java >= 1.2. This method adds all files in the given directories (but not in sub-directories!) to the classpath, so that you don't have to specify them all one by one.
- Parameters:
extdirs
- - Path to append files to
public void addFilelist(FileList fl) throws BuildException
Adds a nested<filelist>
element.
public void addJavaRuntime()
Add the Java Runtime classes to this Path instance.
public Object clone()
Return a Path that holds the same elements as this instance.
public Path concatSystemClasspath()
Concatenates the system class path in the order specified by the ${build.sysclasspath} property - using "last" as default value.
public 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.
public Path.PathElement createPathElement() throws BuildException
Creates the nested<pathelement>
element.
protected void dieOnCircularReference(Stack stk, Project p) throws BuildException
Overrides the version of DataType to recurse on all DataType child elements that may have been added.
- Overrides:
- dieOnCircularReference in interface DataType
public String[] list()
Returns all path elements defined by this and nested path objects.
- Returns:
- list of path elements.
public void setLocation(File location) throws BuildException
Adds a element definition to the path.
- Parameters:
location
- the location of the element to add (must not benull
nor empty.
public void setPath(String path) throws BuildException
Parses a path definition and creates single PathElements.
- Parameters:
path
- theString
path definition.
public void setRefid(Reference r) throws BuildException
Makes this instance in effect a reference to another Path instance. You must not set another attribute or nest elements inside this element if you make it a reference.
public int size()
How many parts does this Path instance consist of.
public String toString()
Returns a textual representation of the path, which can be used as CLASSPATH or PATH environment variable definition.
- Returns:
- a textual representation of the path.
public 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.
public static String[] translatePath(Project project, String source)
Splits a PATH (with : or ; as separators) into its parts.