Modifier and Type	Class and Description
public static class	AbstractClasspathResource.ClassLoaderWithFlag

Modifier and Type	Field and Description
private Path	classpath
private Reference	loader
private boolean	parentFirst

Access	Constructor and Description
public	AbstractClasspathResource()

Method Summary

Modifier and Type	Method and Description
public Path	Returns: The classpath to be configured createClasspath() Add a classpath to use when looking up a resource.
protected synchronized void	dieOnCircularReference(Stack<Object> the stack of references to check. stk, Project the project to use to dereference the references. p) Overrides org.apache.tools.ant.types.DataType.dieOnCircularReference. 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.ClassLoaderWithFlag	Returns: 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.
public Path	Returns: The classpath getClasspath() get the classpath used by this `LoadProperties`.
public InputStream	Returns: an InputStream object. getInputStream() Overrides org.apache.tools.ant.types.Resource.getInputStream. Return an InputStream for reading the contents of this Resource.
public Reference	Returns: the loader. getLoader() Get the loader.
protected AbstractClasspathResource	getRef() Overrides org.apache.tools.ant.types.Resource.getRef. Perform the check for circular references and return the referenced Resource.
public boolean	Returns: true if this resource exists. isExists() Overrides org.apache.tools.ant.types.Resource.isExists. Learn whether this resource exists.
protected abstract InputStream	Returns: an open input stream for the resource openInputStream(ClassLoader the classloader to use. Will be null if the system classloader is used cl) open the input stream from a specific classloader
public void	setClasspath(Path to add to any existing classpath classpath) Set the classpath to use when looking up a resource.
public void	setClasspathRef(Reference The reference value r) Set the classpath to use when looking up a resource, given as reference to a <path> defined elsewhere
public void	setLoaderRef(Reference the reference to locate the loader. r) Use the reference to locate the loader.
public void	setParentFirst(boolean boolean b) Whether to consult the parent classloader first.
public void	setRefid(Reference the Reference to set. r) Overrides org.apache.tools.ant.types.Resource.setRefid. Overrides the super version.

Field Detail

classpath	back to summary
private Path classpath

loader	back to summary
private Reference loader

parentFirst	back to summary
private boolean parentFirst

Constructor Detail

AbstractClasspathResource	back to summary
public AbstractClasspathResource()

Method Detail

createClasspath	back to summary
public Path createClasspath() Add a classpath to use when looking up a resource. Returns:Path The classpath to be configured

createClasspath

back to summary

public Path createClasspath()

Add a classpath to use when looking up a resource.

Returns:Path: The classpath to be configured

dieOnCircularReference back to summary

dieOnCircularReference	back to summary
protected synchronized void dieOnCircularReference(Stack<Object> stk, Project p) Overrides org.apache.tools.ant.types.DataType.dieOnCircularReference. Doc from org.apache.tools.ant.types.DataType.dieOnCircularReference. 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). 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 `checked` is true and set it to true on exit. Parameters stk:Stack<Object> the stack of references to check. p:Project the project to use to dereference the references.

protected synchronized void dieOnCircularReference(Stack<Object> stk, Project p)

Overrides org.apache.tools.ant.types.DataType.dieOnCircularReference.

Doc from org.apache.tools.ant.types.DataType.dieOnCircularReference.

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).

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 checked is true and set it to true on exit.

Parameters

stk:Stack<Object>: the stack of references to check.
p:Project: the project to use to dereference the references.

getClassLoader	back to summary
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:AbstractClasspathResource.ClassLoaderWithFlag ClassLoaderWithFlag

getClassLoader

back to summary

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:AbstractClasspathResource.ClassLoaderWithFlag: ClassLoaderWithFlag

getClasspath back to summary

getClasspath	back to summary
public Path getClasspath() get the classpath used by this `LoadProperties`. Returns:Path The classpath

public Path getClasspath()

get the classpath used by this LoadProperties.

Returns:Path: The classpath

getInputStream	back to summary
public InputStream getInputStream() throws IOException Overrides org.apache.tools.ant.types.Resource.getInputStream. Return an InputStream for reading the contents of this Resource. Returns:InputStream an InputStream object. Exceptions IOException: if an error occurs.

getInputStream

back to summary

public InputStream getInputStream() throws IOException

Overrides org.apache.tools.ant.types.Resource.getInputStream.

Return an InputStream for reading the contents of this Resource.

Returns:InputStream

an InputStream object.

Exceptions

IOException:: if an error occurs.

getLoader	back to summary
public Reference getLoader() Get the loader. Returns:Reference the loader.

getLoader

back to summary

public Reference getLoader()

Get the loader.

Returns:Reference: the loader.

getRef back to summary

getRef	back to summary
protected AbstractClasspathResource getRef() Overrides org.apache.tools.ant.types.Resource.getRef. Doc from org.apache.tools.ant.types.Resource.getRef. Perform the check for circular references and return the referenced Resource. Returns:AbstractClasspathResource `Resource`. Annotations @Override

protected AbstractClasspathResource getRef()

Overrides org.apache.tools.ant.types.Resource.getRef.

Doc from org.apache.tools.ant.types.Resource.getRef.

Perform the check for circular references and return the referenced Resource.

Returns:AbstractClasspathResource

Resource.

Annotations

@Override

isExists	back to summary
public boolean isExists() Overrides org.apache.tools.ant.types.Resource.isExists. Learn whether this resource exists. This implementation opens the input stream as the test. Returns:boolean true if this resource exists.

isExists

back to summary

public boolean isExists()

Overrides org.apache.tools.ant.types.Resource.isExists.

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

Returns:boolean: true if this resource exists.

openInputStream	back to summary
protected abstract InputStream openInputStream(ClassLoader cl) throws IOException open the input stream from a specific classloader Parameters cl:ClassLoader the classloader to use. Will be null if the system classloader is used Returns:InputStream an open input stream for the resource Exceptions IOException: if an error occurs.

openInputStream

back to summary

protected abstract InputStream openInputStream(ClassLoader cl) throws IOException

open the input stream from a specific classloader

Parameters

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

Returns:InputStream

an open input stream for the resource

Exceptions

IOException:: if an error occurs.

setClasspath	back to summary
public void setClasspath(Path classpath) Set the classpath to use when looking up a resource. Parameters classpath:Path to add to any existing classpath

setClasspath

back to summary

public void setClasspath(Path classpath)

Set the classpath to use when looking up a resource.

Parameters

classpath:Path: to add to any existing classpath

setClasspathRef	back to summary
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:Reference The reference value

setClasspathRef

back to summary

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:Reference: The reference value

setLoaderRef	back to summary
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:Reference the reference to locate the loader.

setLoaderRef

back to summary

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:Reference: the reference to locate the loader.

setParentFirst	back to summary
public void setParentFirst(boolean b) Whether to consult the parent classloader first. Only relevant if a classpath has been specified. Parameters b:boolean boolean Since Ant 1.8.0

setParentFirst

back to summary

public void setParentFirst(boolean b)

Whether to consult the parent classloader first.

Only relevant if a classpath has been specified.

Parameters

b:boolean: boolean

Since

Ant 1.8.0

setRefid	back to summary
public void setRefid(Reference r) Overrides org.apache.tools.ant.types.Resource.setRefid. Overrides the super version. Parameters r:Reference the Reference to set.

setRefid

back to summary

public void setRefid(Reference r)

Overrides org.apache.tools.ant.types.Resource.setRefid.

Overrides the super version.

Parameters

r:Reference: the Reference to set.

org.apache.tools.ant.types.resources back to summary

public Class AbstractClasspathResource.ClassLoaderWithFlag

Class Inheritance

extends Object

java.lang.Object
org.apache.tools.ant.types.resources.AbstractClasspathResource.ClassLoaderWithFlag

Field Summary

Modifier and Type	Field and Description
private final boolean	cleanup
private final ClassLoader	loader

Constructor Summary

Access	Constructor and Description
pack-priv	ClassLoaderWithFlag(ClassLoader l, boolean needsCleanup)

Method Summary

Modifier and Type	Method and Description
public void	cleanup()
public ClassLoader	getLoader()
public boolean	needsCleanup()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cleanup	back to summary
private final boolean cleanup

loader	back to summary
private final ClassLoader loader

Constructor Detail

ClassLoaderWithFlag	back to summary
pack-priv ClassLoaderWithFlag(ClassLoader l, boolean needsCleanup)

Method Detail

cleanup	back to summary
public void cleanup()

getLoader	back to summary
public ClassLoader getLoader()

needsCleanup	back to summary
public boolean needsCleanup()

public abstract Class AbstractClasspathResource

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class AbstractClasspathResource.ClassLoaderWithFlag

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail