org.apache.tools.ant.taskdefs

Class WhichResource

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.tools.ant.taskdefs.WhichResource

All Implemented Interfaces:

Cloneable

public class WhichResource
extends Task

Find a class or resource on the supplied classpath, or the system classpath if none is supplied. The named property is set if the item can be found. For example

 <whichresource resource="/log4j.properties"
   property="log4j.url" >
 

Since:

Ant 1.6

Constructor Summary

Constructors

Constructor and Description
WhichResource()

Method Summary

Modifier and Type	Method and Description
Path	createClasspath() Adds a path to the classpath.
void	execute() execute it
void	setClass(String classname) name the class to look for
void	setClasspath(Path cp) Set the classpath to be used for this compilation.
void	setClasspathRef(Reference r) Set the classpath to use by reference.
void	setProperty(String property) the property to fill with the URL of the resource or class
void	setResource(String resource) name the resource to look for

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

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, maybeConfigure, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

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

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WhichResource

public WhichResource()

Method Detail

createClasspath

public Path createClasspath()

Adds a path to the classpath.

Returns:

a classpath to be configured.

execute

public void execute()
             throws BuildException

execute it

Overrides:

execute in class Task

Throws:

BuildException - on error

setClass

public void setClass(String classname)

name the class to look for

Parameters:

classname - the name of the class to look for.

setClasspath

public void setClasspath(Path cp)

Set the classpath to be used for this compilation.

Parameters:

cp - the classpath to be used.

setClasspathRef

public void setClasspathRef(Reference r)

Set the classpath to use by reference.

Parameters:

r - a reference to an existing classpath.

Since:

Ant 1.7.1

setProperty

public void setProperty(String property)

the property to fill with the URL of the resource or class

Parameters:

property - the property to be set.

setResource

public void setResource(String resource)

name the resource to look for

Parameters:

resource - the name of the resource to look for.