Class AbstractClasspathResource
- java.lang.Object
-
- org.apache.tools.ant.ProjectComponent
-
- org.apache.tools.ant.types.DataType
-
- org.apache.tools.ant.types.Resource
-
- org.apache.tools.ant.types.resources.AbstractClasspathResource
-
- All Implemented Interfaces:
java.lang.Cloneable,java.lang.Comparable<Resource>,java.lang.Iterable<Resource>,ResourceCollection
- Direct Known Subclasses:
JavaConstantResource,JavaResource
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
Nested Classes Modifier and Type Class Description static classAbstractClasspathResource.ClassLoaderWithFlag
-
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.ProjectComponent
description, location, project
-
-
Constructor Summary
Constructors Constructor Description AbstractClasspathResource()
-
Method Summary
Modifier and Type Method Description PathcreateClasspath()Add a classpath to use when looking up a resource.protected voiddieOnCircularReference(java.util.Stack<java.lang.Object> stk, Project p)Check to see whether any DataType we hold references to is included in the Stack (which holds all DataType instances that directly or indirectly reference this instance, including this instance itself).protected AbstractClasspathResource.ClassLoaderWithFlaggetClassLoader()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.PathgetClasspath()get the classpath used by thisLoadProperties.java.io.InputStreamgetInputStream()Return an InputStream for reading the contents of this Resource.ReferencegetLoader()Get the loader.protected AbstractClasspathResourcegetRef()Perform the check for circular references and return the referenced Resource.booleanisExists()Learn whether this resource exists.protected abstract java.io.InputStreamopenInputStream(java.lang.ClassLoader cl)open the input stream from a specific classloadervoidsetClasspath(Path classpath)Set the classpath to use when looking up a resource.voidsetClasspathRef(Reference r)Set the classpath to use when looking up a resource, given as reference to a <path> defined elsewherevoidsetLoaderRef(Reference r)Use the reference to locate the loader.voidsetParentFirst(boolean b)Whether to consult the parent classloader first.voidsetRefid(Reference r)Overrides the super version.-
Methods inherited from class org.apache.tools.ant.types.Resource
as, asOptional, clone, compareTo, equals, getLastModified, getMagicNumber, getName, getOutputStream, getSize, hashCode, isDirectory, isFilesystemOnly, iterator, setDirectory, setExists, setLastModified, setName, setSize, size, toLongString, toString
-
Methods inherited from class org.apache.tools.ant.types.DataType
checkAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributes
-
Methods inherited from class org.apache.tools.ant.ProjectComponent
getDescription, getLocation, getProject, log, log, setDescription, setLocation, setProject
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.tools.ant.types.ResourceCollection
isEmpty, stream
-
-
-
-
Method Detail
-
setClasspath
public void setClasspath(Path classpath)
Set the classpath to use when looking up a resource.- Parameters:
classpath- to add to any existing classpath
-
createClasspath
public Path createClasspath()
Add a classpath to use when looking up a resource.- Returns:
- The classpath to be configured
-
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
-
getClasspath
public Path getClasspath()
get the classpath used by thisLoadProperties.- Returns:
- The classpath
-
getLoader
public Reference getLoader()
Get the loader.- Returns:
- the loader.
-
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.
-
setParentFirst
public void setParentFirst(boolean b)
Whether to consult the parent classloader first.Only relevant if a classpath has been specified.
- Parameters:
b- boolean- Since:
- Ant 1.8.0
-
setRefid
public void setRefid(Reference r)
Overrides the super version.
-
isExists
public boolean isExists()
Learn whether this resource exists. This implementation opens the input stream as the test.
-
getInputStream
public java.io.InputStream getInputStream() throws java.io.IOExceptionReturn an InputStream for reading the contents of this Resource.- Overrides:
getInputStreamin classResource- Returns:
- an InputStream object.
- Throws:
java.io.IOException- if an error occurs.
-
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.- Returns:
- ClassLoaderWithFlag
-
openInputStream
protected abstract java.io.InputStream openInputStream(java.lang.ClassLoader cl) throws java.io.IOExceptionopen the input 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:
java.io.IOException- if an error occurs.
-
dieOnCircularReference
protected void dieOnCircularReference(java.util.Stack<java.lang.Object> stk, Project p)Description copied from class:DataTypeCheck to see whether any DataType we hold references to is included in the Stack (which holds all DataType instances that directly or indirectly reference this instance, including this instance itself).If one is included, throw a BuildException created by
circularReference.This implementation is appropriate only for a DataType that cannot hold other DataTypes as children.
The general contract of this method is that it shouldn't do anything if
DataType.checkedis true and set it to true on exit.- Overrides:
dieOnCircularReferencein classDataType- Parameters:
stk- the stack of references to check.p- the project to use to dereference the references.
-
getRef
protected AbstractClasspathResource getRef()
Description copied from class:ResourcePerform the check for circular references and return the referenced Resource.
-
-