|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.tools.ant.util.ClasspathUtils
Offers some helper methods on the Path structure in ant.
Basic idea behind this utility class is to use it from inside the different ant objects (and user defined objects) that need classLoading for their operation. Normally those would have a setClasspathRef() {for the @classpathref} and/or a createClasspath() {for the nested <classpath>} Typically one would have in your Ant Task or DataType
ClasspathUtils.Delegate cpDelegate;
public void init() {
this.cpDelegate = ClasspathUtils.getDelegate(this);
super.init();
}
public void setClasspathRef(Reference r) {
this.cpDelegate.setClasspathRef(r);
}
public Path createClasspath() {
return this.cpDelegate.createClasspath();
}
public void setClassname(String fqcn) {
this.cpDelegate.setClassname(fqcn);
}
At execution time, when you actually need the classloading you can just:
Object o = this.cpDelegate.newInstance();
Nested Class Summary | |
static class |
ClasspathUtils.Delegate
Delegate that helps out any specific ProjectComponent that needs dynamic classloading. |
Field Summary | |
static java.lang.String |
REUSE_LOADER_REF
Name of the magic property that controls classloader reuse in Ant 1.4. |
Constructor Summary | |
ClasspathUtils()
|
Method Summary | |
static java.lang.ClassLoader |
getClassLoaderForPath(Project p,
Path path,
java.lang.String loaderId)
Convenience overloaded version of getClassLoaderForPath(Project, Path, String, boolean) . |
static java.lang.ClassLoader |
getClassLoaderForPath(Project p,
Path path,
java.lang.String loaderId,
boolean reverseLoader)
Convenience overloaded version of getClassLoaderForPath(Project, Path, String, boolean, boolean) . |
static java.lang.ClassLoader |
getClassLoaderForPath(Project p,
Path path,
java.lang.String loaderId,
boolean reverseLoader,
boolean reuseLoader)
Gets a classloader that loads classes from the classpath defined in the path argument. |
static java.lang.ClassLoader |
getClassLoaderForPath(Project p,
Reference ref)
Convenience overloaded version of getClassLoaderForPath(Project, Reference, boolean) . |
static java.lang.ClassLoader |
getClassLoaderForPath(Project p,
Reference ref,
boolean reverseLoader)
Convenience overloaded version of getClassLoaderForPath(Project, Path,
String, boolean) . |
static ClasspathUtils.Delegate |
getDelegate(ProjectComponent component)
Obtains a delegate that helps out with classic classpath configuration. |
static java.lang.ClassLoader |
getUniqueClassLoaderForPath(Project p,
Path path,
boolean reverseLoader)
Gets a fresh, different, not used before classloader that uses the passed path as it's classpath. |
static java.lang.Object |
newInstance(java.lang.String className,
java.lang.ClassLoader userDefinedLoader)
Creates a fresh object instance of the specified classname. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String REUSE_LOADER_REF
Constructor Detail |
public ClasspathUtils()
Method Detail |
public static java.lang.ClassLoader getClassLoaderForPath(Project p, Reference ref)
getClassLoaderForPath(Project, Reference, boolean)
.
Assumes the logical 'false' for the reverseLoader.
p
- ref
-
public static java.lang.ClassLoader getClassLoaderForPath(Project p, Reference ref, boolean reverseLoader)
getClassLoaderForPath(Project, Path,
String, boolean)
.
Delegates to the other one after extracting the referenced Path from the Project This checks also that the passed Reference is pointing to a Path all right.
p
- current ant projectref
- Reference to Path structurereverseLoader
- if set to true this new loader will take
precedence over it's parent (which is contra the regular
classloader behaviour)
public static java.lang.ClassLoader getClassLoaderForPath(Project p, Path path, java.lang.String loaderId)
getClassLoaderForPath(Project, Path, String, boolean)
.
Assumes the logical 'false' for the reverseLoader.
path
- loaderId
-
public static java.lang.ClassLoader getClassLoaderForPath(Project p, Path path, java.lang.String loaderId, boolean reverseLoader)
getClassLoaderForPath(Project, Path, String, boolean, boolean)
.
Sets value for 'reuseLoader' to true if the magic property has been set.
path
- loaderId
-
public static java.lang.ClassLoader getClassLoaderForPath(Project p, Path path, java.lang.String loaderId, boolean reverseLoader, boolean reuseLoader)
Based on the setting of the magic property 'ant.reuse.loader' this will try to reuse the perviously created loader with that id, and of course store it there upon creation.
path
- Path object to be used as classpath for this classloaderloaderId
- identification for this Loader,reverseLoader
- if set to true this new loader will take
precedence over it's parent (which is contra the regularp
- Ant Project where the handled components are living in.
classloader behaviour)
public static java.lang.ClassLoader getUniqueClassLoaderForPath(Project p, Path path, boolean reverseLoader)
This method completely ignores the ant.reuse.loader magic property and should be used with caution.
path
- the classpath for this loaderreverseLoader
-
public static java.lang.Object newInstance(java.lang.String className, java.lang.ClassLoader userDefinedLoader)
This uses the userDefinedLoader to load the specified class, and then makes an instance using the default no-argument constructor
className
- the full qualified class name to load.userDefinedLoader
- the classloader to use.
BuildException
- when loading or instantiation failed.public static ClasspathUtils.Delegate getDelegate(ProjectComponent component)
component
- your projectComponent that needs the assistence
ClasspathUtils.Delegate
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |