org.apache.tools.ant.taskdefs

Class DefBase

public abstract class DefBase extends AntlibDefinition

Base class for Definitions handling uri and class loading. (This was part of Definer)

Since: Ant 1.6

Method Summary
PathcreateClasspath()
Create the classpath to be used when searching for component being defined.
protected ClassLoadercreateLoader()
create a classloader for this definition
PathgetClasspath()
StringgetClasspathId()
Returns the class path id of the class path delegate.
StringgetLoaderId()
Returns the loader id of the class path Delegate.
protected booleanhasCpDelegate()
Check if classpath attributes have been set. (to be called before getCpDelegate() is used.
voidinit()
booleanisReverseLoader()
voidsetClasspath(Path classpath)
Set the classpath to be used when searching for component being defined.
voidsetClasspathRef(Reference r)
Set a reference to a classpath to use when loading the files.
voidsetLoaderRef(Reference r)
Use the reference to locate the loader.
voidsetReverseLoader(boolean reverseLoader)

Method Detail

createClasspath

public Path createClasspath()
Create the classpath to be used when searching for component being defined.

Returns: the classpath of the this definition

createLoader

protected ClassLoader createLoader()
create a classloader for this definition

Returns: the classloader from the cpDelegate

getClasspath

public Path getClasspath()

Returns: the classpath for this definition

getClasspathId

public String getClasspathId()
Returns the class path id of the class path delegate.

Returns: the class path id

getLoaderId

public String getLoaderId()
Returns the loader id of the class path Delegate.

Returns: the loader id

hasCpDelegate

protected boolean hasCpDelegate()
Check if classpath attributes have been set. (to be called before getCpDelegate() is used.

Returns: true if cpDelegate has been created.

init

public void init()

Throws: BuildException on error.

Since: Ant 1.6

See Also: init

isReverseLoader

public boolean isReverseLoader()

Returns: the reverse loader attribute of the classpath delegate.

setClasspath

public void setClasspath(Path classpath)
Set the classpath to be used when searching for component being defined.

Parameters: classpath an Ant Path object containing the classpath.

setClasspathRef

public void setClasspathRef(Reference r)
Set a reference to a classpath to use when loading the files. To actually share the same loader, set loaderref as well

Parameters: r the reference to the classpath

setLoaderRef

public void setLoaderRef(Reference r)
Use the reference to locate the loader. If the loader is not found, the specified classpath will be used and registered with the specified name. This allows multiple taskdef/typedef to use the same class loader, so they can be used together, eliminating the need to put them in the CLASSPATH.

Parameters: r the reference to locate the loader.

Since: Ant 1.5

setReverseLoader

public void setReverseLoader(boolean reverseLoader)

Deprecated: since 1.6.x. stop using this attribute

Parameters: reverseLoader if true a delegated loader will take precedence over the parent

UNKNOWN: ignore="true"