org.apache.tools.ant.taskdefs
Class Available
- Condition
Will set the given property if the requested resource is available at
runtime. This task may also be used as a condition by the condition task.
static class | Available.FileDir - EnumeratedAttribute covering the file types to be checked for, either
file or dir.
|
Path | createClasspath() - Classpath to be used when searching for classes and resources.
|
Path | createFilepath() - Path to search for file resources.
|
boolean | eval() - Evaluate the availability of a resource.
|
void | execute() - Entry point when operating as a task.
|
void | setClassname(String classname) - Set a classname of a class which must be available to set the given
property.
|
void | setClasspath(Path classpath) - Set the classpath to be used when searching for classes and resources.
|
void | setClasspathRef(Reference r) - Set the classpath by reference.
|
void | setFile(File file) - Set the file which must be present in the file system to set the given
property.
|
void | setFilepath(Path filepath) - Set the path to use when looking for a file.
|
void | setIgnoresystemclasses(boolean ignore) - Set whether the search for classes should ignore the runtime classes and
just use the given classpath.
|
void | setProperty(String property) - Set the name of the property which will be set if the particular resource
is available.
|
void | setResource(String resource) - Set the name of a Java resource which is required to set the property.
|
void | setType(String type) - setType(String) is deprecated and is replaced with
setType(Available.FileDir) to make Ant's Introspection
mechanism do the work and also to encapsulate operations on
the type in its own class.
|
void | setType(Available.FileDir type) - Set what type of file is required - either directory or file.
|
void | setValue(String value) - Set the value to be given to the property if the desired resource is
available.
|
execute , getDescription , getLocation , getOwningTarget , getRuntimeConfigurableWrapper , getTaskName , getTaskType , getWrapper , handleErrorFlush , handleErrorOutput , handleFlush , handleInput , handleOutput , init , isInvalid , log , log , maybeConfigure , perform , reconfigure , setDescription , setLocation , setOwningTarget , setRuntimeConfigurableWrapper , setTaskName , setTaskType |
createClasspath
public Path createClasspath()
Classpath to be used when searching for classes and resources.
- an empty Path instance to be configured by Ant.
createFilepath
public Path createFilepath()
Path to search for file resources.
- a new Path instance which Ant will configure with a file search
path.
eval
public boolean eval()
throws BuildException
Evaluate the availability of a resource.
- eval in interface Condition
- boolean is the resource is available.
setClassname
public void setClassname(String classname)
Set a classname of a class which must be available to set the given
property.
classname
- the name of the class required.
setClasspath
public void setClasspath(Path classpath)
Set the classpath to be used when searching for classes and resources.
classpath
- an Ant Path object containing the search path.
setClasspathRef
public void setClasspathRef(Reference r)
Set the classpath by reference.
r
- a Reference to a Path instance to be used as the classpath
value.
setFile
public void setFile(File file)
Set the file which must be present in the file system to set the given
property.
file
- the name of the file which is required.
setFilepath
public void setFilepath(Path filepath)
Set the path to use when looking for a file.
filepath
- a Path instance containing the search path for files.
setIgnoresystemclasses
public void setIgnoresystemclasses(boolean ignore)
Set whether the search for classes should ignore the runtime classes and
just use the given classpath.
ignore
- true if system classes are to be ignored.
setProperty
public void setProperty(String property)
Set the name of the property which will be set if the particular resource
is available.
property
- the name of the property to set.
setResource
public void setResource(String resource)
Set the name of a Java resource which is required to set the property.
resource
- the name of a resource which is required to be available.
setType
public void setType(String type)
setType(String) is deprecated and is replaced with
setType(Available.FileDir) to make Ant's Introspection
mechanism do the work and also to encapsulate operations on
the type in its own class.
type
- the type of resource
setType
public void setType(Available.FileDir type)
Set what type of file is required - either directory or file.
type
- an instance of the FileDir enumeratedAttribute indicating
whether the file required is to be a directory or a plain
file.
setValue
public void setValue(String value)
Set the value to be given to the property if the desired resource is
available.
value
- the value to be given.
Copyright B) 2000-2008 Apache Software Foundation. All Rights Reserved.