org.apache.tools.ant.types.resources

Class AbstractClasspathResource

public abstract class AbstractClasspathResource extends Resource

A Resource representation of anything that is accessed via a Java classloader. The core methods to set/resolve the classpath are provided.

Since: Ant 1.8.0

Nested Class Summary
static class	AbstractClasspathResource.ClassLoaderWithFlag

Method Summary
Path	createClasspath() Add a classpath to use when looking up a resource.
protected void	dieOnCircularReference(Stack stk, Project p)
protected AbstractClasspathResource.ClassLoaderWithFlag	getClassLoader() combines the various ways that could specify a ClassLoader and potentially creates one that needs to be cleaned up when it is no longer needed so that classes can get garbage collected.
Path	getClasspath() get the classpath used by this `LoadProperties`.
InputStream	getInputStream() Return an InputStream for reading the contents of this Resource.
Reference	getLoader() Get the loader.
boolean	isExists() Learn whether this resource exists.
protected abstract InputStream	openInputStream(ClassLoader cl) open the inpout stream from a specific classloader
void	setClasspath(Path classpath) Set the classpath to use when looking up a resource.
void	setClasspathRef(Reference r) Set the classpath to use when looking up a resource, given as reference to a <path> defined elsewhere
void	setLoaderRef(Reference r) Use the reference to locate the loader.
void	setParentFirst(boolean b) Whether to consult the parent classloader first.
void	setRefid(Reference r) Overrides the super version.

Method Detail

createClasspath

public Path createClasspath()

Add a classpath to use when looking up a resource.

Returns: The classpath to be configured

dieOnCircularReference

protected void dieOnCircularReference(Stack stk, Project p)

getClassLoader

protected AbstractClasspathResource.ClassLoaderWithFlag getClassLoader()

combines the various ways that could specify a ClassLoader and potentially creates one that needs to be cleaned up when it is no longer needed so that classes can get garbage collected.

getClasspath

public Path getClasspath()

get the classpath used by this LoadProperties.

Returns: The classpath

getInputStream

public InputStream getInputStream()

Return an InputStream for reading the contents of this Resource.

Returns: an InputStream object.

Throws: IOException if an error occurs.

getLoader

public Reference getLoader()

Get the loader.

Returns: the loader.

isExists

public boolean isExists()

Learn whether this resource exists. This implementation opens the input stream as the test.

Returns: true if this resource exists.

openInputStream

protected abstract InputStream openInputStream(ClassLoader cl)

open the inpout stream from a specific classloader

Parameters: cl the classloader to use. Will be null if the system classloader is used

Returns: an open input stream for the resource

Throws: IOException if an error occurs.

setClasspath

public void setClasspath(Path classpath)

Set the classpath to use when looking up a resource.

Parameters: classpath to add to any existing classpath

setClasspathRef

public void setClasspathRef(Reference r)

Set the classpath to use when looking up a resource, given as reference to a <path> defined elsewhere

Parameters: r The reference value

Use the reference to locate the loader. If the loader is not found, taskdef will use the specified classpath and register it with the specified name. This allow multiple taskdef/typedef to use the same class loader, so they can be used together. It eliminate the need to put them in the CLASSPATH.

Parameters: r the reference to locate the loader.

setParentFirst

public void setParentFirst(boolean b)

Whether to consult the parent classloader first.

Only relevant if a classpath has been specified.

Since: Ant 1.8.0

setRefid

public void setRefid(Reference r)

Overrides the super version.

Parameters: r the Reference to set.