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:
- Cloneable,- Comparable<Resource>,- Iterable<Resource>,- ResourceCollection
- Direct Known Subclasses:
- JavaConstantResource,- JavaResource
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 SummaryNested Classes
- 
Field SummaryFields inherited from class org.apache.tools.ant.types.ResourceMAGIC, UNKNOWN_DATETIME, UNKNOWN_SIZEFields inherited from class org.apache.tools.ant.ProjectComponentdescription, location, project
- 
Constructor SummaryConstructors
- 
Method SummaryModifier and TypeMethodDescriptionAdd a classpath to use when looking up a resource.protected voiddieOnCircularReference(Stack<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).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.get the classpath used by thisLoadProperties.Return an InputStream for reading the contents of this Resource.Get the loader.protected AbstractClasspathResourcegetRef()Perform the check for circular references and return the referenced Resource.booleanisExists()Learn whether this resource exists.protected abstract InputStreamopen the input stream from a specific classloadervoidsetClasspath(Path classpath) Set the classpath to use when looking up a resource.voidSet the classpath to use when looking up a resource, given as reference to a <path> defined elsewherevoidUse the reference to locate the loader.voidsetParentFirst(boolean b) Whether to consult the parent classloader first.voidOverrides the super version.Methods inherited from class org.apache.tools.ant.types.Resourceas, asOptional, clone, compareTo, equals, getLastModified, getMagicNumber, getName, getOutputStream, getSize, hashCode, isDirectory, isFilesystemOnly, iterator, setDirectory, setExists, setLastModified, setName, setSize, size, toLongString, toStringMethods inherited from class org.apache.tools.ant.types.DataTypecheckAttributesAllowed, checkChildrenAllowed, circularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, tooManyAttributesMethods inherited from class org.apache.tools.ant.ProjectComponentgetDescription, getLocation, getProject, log, log, setDescription, setLocation, setProjectMethods inherited from class java.lang.Objectfinalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface java.lang.IterableforEach, spliteratorMethods inherited from interface org.apache.tools.ant.types.ResourceCollectionisEmpty, stream
- 
Constructor Details- 
AbstractClasspathResourcepublic AbstractClasspathResource()
 
- 
- 
Method Details- 
setClasspathSet the classpath to use when looking up a resource.- Parameters:
- classpath- to add to any existing classpath
 
- 
createClasspathAdd a classpath to use when looking up a resource.- Returns:
- The classpath to be configured
 
- 
setClasspathRefSet the classpath to use when looking up a resource, given as reference to a <path> defined elsewhere- Parameters:
- r- The reference value
 
- 
getClasspathget the classpath used by thisLoadProperties.- Returns:
- The classpath
 
- 
getLoaderGet the loader.- Returns:
- the loader.
 
- 
setLoaderRefUse 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.
 
- 
setParentFirstpublic 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
 
- 
setRefidOverrides the super version.
- 
isExistspublic boolean isExists()Learn whether this resource exists. This implementation opens the input stream as the test.
- 
getInputStreamReturn an InputStream for reading the contents of this Resource.- Overrides:
- getInputStreamin class- Resource
- Returns:
- an InputStream object.
- Throws:
- IOException- if an error occurs.
 
- 
getClassLoadercombines 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
 
- 
openInputStreamopen 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:
- IOException- if an error occurs.
 
- 
dieOnCircularReferenceDescription 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 class- DataType
- Parameters:
- stk- the stack of references to check.
- p- the project to use to dereference the references.
 
- 
getRefDescription copied from class:ResourcePerform the check for circular references and return the referenced Resource.
 
-