org.apache.tools.ant.types.resources

Class JavaResource

public class JavaResource extends Resource

A Resource representation of something loadable via a Java classloader.

Since: Ant 1.7

Constructor Summary
	JavaResource() Default constructor.
	JavaResource(String name, Path path) Construct a new JavaResource using the specified name and classpath.

Method Summary
int	compareTo(Object another) Compare this JavaResource to another Resource.
Path	createClasspath() Add a classpath to use when looking up a resource.
Path	getClasspath() get the classpath used by this `LoadProperties`.
InputStream	getInputStream() Return an InputStream for reading the contents of this Resource.
boolean	isExists() Learn whether this file exists.
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	setRefid(Reference r) Overrides the super version.

Constructor Detail

JavaResource

public JavaResource()

Default constructor.

JavaResource

public JavaResource(String name, Path path)

Construct a new JavaResource using the specified name and classpath.

Parameters: name the resource name. path the classpath.

Method Detail

compareTo

public int compareTo(Object another)

Compare this JavaResource to another Resource.

Parameters: another the other Resource against which to compare.

Returns: a negative integer, zero, or a positive integer as this JavaResource is less than, equal to, or greater than the specified Resource.

createClasspath

public Path createClasspath()

Add a classpath to use when looking up a resource.

Returns: The classpath to be configured

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.

isExists

public boolean isExists()

Learn whether this file exists.

Returns: true if this resource exists.

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.

setRefid

public void setRefid(Reference r)

Overrides the super version.

Parameters: r the Reference to set.