org.apache.tools.ant.types.resources

Class JavaResource

Implemented Interfaces:
Cloneable, Comparable, ResourceCollection

public class JavaResource
extends Resource

A Resource representation of something loadable via a Java classloader.
Since:
Ant 1.7

Field Summary

Fields inherited from class org.apache.tools.ant.types.Resource

MAGIC, UNKNOWN_DATETIME, UNKNOWN_SIZE

Fields inherited from class org.apache.tools.ant.types.DataType

checked, ref

Fields inherited from class org.apache.tools.ant.ProjectComponent

description, location, project

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.

Methods inherited from class org.apache.tools.ant.types.Resource

clone, compareTo, equals, getInputStream, getLastModified, getMagicNumber, getName, getOutputStream, getSize, hashCode, isDirectory, isExists, isFilesystemOnly, iterator, setDirectory, setExists, setLastModified, setName, setRefid, setSize, size, toLongString, toString

Methods inherited from class org.apache.tools.ant.types.DataType

checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, setChecked, setRefid, toString, tooManyAttributes

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject

Constructor Details

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 Details

compareTo

public int compareTo(Object another)
Compare this JavaResource to another Resource.
Overrides:
compareTo in interface 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()
            throws IOException
Return an InputStream for reading the contents of this Resource.
Overrides:
getInputStream in interface Resource
Returns:
an InputStream object.

isExists

public boolean isExists()
Learn whether this file exists.
Overrides:
isExists in interface Resource
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

setLoaderRef

public void setLoaderRef(Reference r)
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.
Overrides:
setRefid in interface Resource
Parameters:
r - the Reference to set.