| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
  |
  +--org.apache.tools.ant.ProjectComponent
        |
        +--org.apache.tools.ant.Task
              |
              +--org.apache.tools.ant.taskdefs.Available
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.
| Nested Class Summary | |
| static class | Available.FileDirEnumeratedAttribute covering the file types to be checked for, either file or dir. | 
| Field Summary | 
| Fields inherited from class org.apache.tools.ant.Task | 
| description, location, target, taskName, taskType, wrapper | 
| Fields inherited from class org.apache.tools.ant.ProjectComponent | 
| project | 
| Constructor Summary | |
| Available() | |
| Method Summary | |
|  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(java.lang.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(java.io.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(java.lang.String property)Set the name of the property which will be set if the particular resource is available. | 
|  void | setResource(java.lang.String resource)Set the name of a Java resource which is required to set the property. | 
|  void | setType(Available.FileDir type)Set what type of file is required - either directory or file. | 
|  void | setType(java.lang.String type)Deprecated. 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 | setValue(java.lang.String value)Set the value to be given to the property if the desired resource is available. | 
| Methods inherited from class org.apache.tools.ant.Task | 
| 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 | 
| Methods inherited from class org.apache.tools.ant.ProjectComponent | 
| getProject, setProject | 
| Methods inherited from class java.lang.Object | 
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
| Constructor Detail | 
public Available()
| Method Detail | 
public void setClasspath(Path classpath)
classpath - an Ant Path object containing the search path.public Path createClasspath()
public void setClasspathRef(Reference r)
r - a Reference to a Path instance to be used as the classpath
          value.public void setFilepath(Path filepath)
filepath - a Path instance containing the search path for files.public Path createFilepath()
public void setProperty(java.lang.String property)
property - the name of the property to set.public void setValue(java.lang.String value)
value - the value to be given.public void setClassname(java.lang.String classname)
classname - the name of the class required.public void setFile(java.io.File file)
file - the name of the file which is required.public void setResource(java.lang.String resource)
resource - the name of a resource which is required to be available.public void setType(java.lang.String type)
type - the type of resourcepublic void setType(Available.FileDir type)
type - an instance of the FileDir enumeratedAttribute indicating
             whether the file required is to be a directory or a plain
             file.public void setIgnoresystemclasses(boolean ignore)
ignore - true if system classes are to be ignored.
public void execute()
             throws BuildException
execute in class TaskBuildException - if the task is not configured correctly.
public boolean eval()
             throws BuildException
eval in interface ConditionBuildException - if the condition is not configured correctly| 
 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||