Modifier and Type	Class and Description
public static class	Available.FileDir EnumeratedAttribute covering the file types to be checked for, either file or dir.

Modifier and Type	Field and Description
private String	classname
private Path	classpath
private File	file
private static final FileUtils	FILE_UTILS
private String	filename
private Path	filepath
private boolean	ignoreSystemclasses
private boolean	isTask
private AntClassLoader	loader
private String	property
private String	resource
private boolean	searchParents
private Available.FileDir	type
private Object	value

Access	Constructor and Description
public	Available()

Method Summary

Modifier and Type	Method and Description
private boolean	checkClass(String classname) Check if a given class can be loaded.
private boolean	checkFile() Search for file/directory either relative to project's basedir or in the path given as filepath.
private boolean	checkFile(File f, String text) Check if a given file exists and matches the required type.
private boolean	checkResource(String resource) Check if a given resource can be loaded.
public Path	Returns: an empty Path instance to be configured by Ant. createClasspath() Classpath to be used when searching for classes and resources.
public Path	Returns: a new Path instance which Ant will configure with a file search path. createFilepath() Path to search for file resources.
public boolean	Returns: boolean is the resource is available. eval() Implements org.apache.tools.ant.taskdefs.condition.Condition.eval. Evaluate the availability of a resource.
public void	execute() Overrides org.apache.tools.ant.Task.execute. Entry point when operating as a task.
public void	setClassname(String the name of the class required. classname) Set a classname of a class which must be available to set the given property.
public void	setClasspath(Path an Ant Path object containing the search path. classpath) Set the classpath to be used when searching for classes and resources.
public void	setClasspathRef(Reference a Reference to a Path instance to be used as the classpath value. r) Set the classpath by reference.
public void	setFile(File the name of the file which is required. file) Set the file which must be present in the file system to set the given property.
public void	setFilepath(Path a Path instance containing the search path for files. filepath) Set the path to use when looking for a file.
public void	setIgnoresystemclasses(boolean true if system classes are to be ignored. ignore) Set whether the search for classes should ignore the runtime classes and just use the given classpath.
public void	setProperty(String the name of the property to set. property) Set the name of the property which will be set if the particular resource is available.
public void	setResource(String the name of a resource which is required to be available. resource) Set the name of a Java resource which is required to set the property.
public void	setSearchParents(boolean the value to set. searchParents) Set the searchParents attribute.
public void	setType(String the type of resource type) Deprecated since 1.5.x.
public void	setType(Available.FileDir an instance of the FileDir enumeratedAttribute indicating whether the file required is to be a directory or a plain file. type) Set what type of file is required - either directory or file.
public void	setValue(Object the value to be given. value) Set the value to be given to the property if the desired resource is available.
public void	setValue(String the value to be given. value) Set the value to be given to the property if the desired resource is available.

Field Detail

classname	back to summary
private String classname

classpath	back to summary
private Path classpath

file	back to summary
private File file

FILE_UTILS	back to summary
private static final FileUtils FILE_UTILS

filename	back to summary
private String filename

filepath	back to summary
private Path filepath

ignoreSystemclasses	back to summary
private boolean ignoreSystemclasses

isTask	back to summary
private boolean isTask

loader	back to summary
private AntClassLoader loader

property	back to summary
private String property

resource	back to summary
private String resource

searchParents	back to summary
private boolean searchParents

type	back to summary
private Available.FileDir type

value	back to summary
private Object value

Constructor Detail

Available	back to summary
public Available()

Method Detail

checkClass	back to summary
private boolean checkClass(String classname) Check if a given class can be loaded.

checkFile	back to summary
private boolean checkFile() Search for file/directory either relative to project's basedir or in the path given as filepath. filepath can be a list of directory and/or file names (gen'd via ) look for: full-pathname specified == path in list full-pathname specified == parent dir of path in list simple name specified == path in list simple name specified == path in list + name simple name specified == parent dir + name simple name specified == parent of parent dir + name

checkFile

back to summary

private boolean checkFile()

Search for file/directory either relative to project's basedir or in the path given as filepath.

filepath can be a list of directory and/or file names (gen'd via )

look for:

full-pathname specified == path in list
full-pathname specified == parent dir of path in list
simple name specified == path in list
simple name specified == path in list + name
simple name specified == parent dir + name
simple name specified == parent of parent dir + name

checkFile	back to summary
private boolean checkFile(File f, String text) Check if a given file exists and matches the required type.

checkResource	back to summary
private boolean checkResource(String resource) Check if a given resource can be loaded.

createClasspath	back to summary
public Path createClasspath() Classpath to be used when searching for classes and resources. Returns:Path an empty Path instance to be configured by Ant.

createClasspath

back to summary

public Path createClasspath()

Classpath to be used when searching for classes and resources.

Returns:Path: an empty Path instance to be configured by Ant.

createFilepath	back to summary
public Path createFilepath() Path to search for file resources. Returns:Path a new Path instance which Ant will configure with a file search path.

createFilepath

back to summary

public Path createFilepath()

Path to search for file resources.

Returns:Path: a new Path instance which Ant will configure with a file search path.

eval	back to summary
public boolean eval() throws BuildException Implements org.apache.tools.ant.taskdefs.condition.Condition.eval. Evaluate the availability of a resource. Returns:boolean boolean is the resource is available. Annotations @Override Exceptions BuildException: if the condition is not configured correctly

eval

back to summary

public boolean eval() throws BuildException

Implements org.apache.tools.ant.taskdefs.condition.Condition.eval.

Evaluate the availability of a resource.

Returns:boolean

boolean is the resource is available.

Annotations

@Override

Exceptions

BuildException:: if the condition is not configured correctly

execute	back to summary
public void execute() throws BuildException Overrides org.apache.tools.ant.Task.execute. Entry point when operating as a task. Annotations @Override Exceptions BuildException: if the task is not configured correctly.

execute

back to summary

public void execute() throws BuildException

Overrides org.apache.tools.ant.Task.execute.

Entry point when operating as a task.

Annotations

@Override

Exceptions

BuildException:: if the task is not configured correctly.

setClassname	back to summary
public void setClassname(String classname) Set a classname of a class which must be available to set the given property. Parameters classname:String the name of the class required.

setClassname

back to summary

public void setClassname(String classname)

Set a classname of a class which must be available to set the given property.

Parameters

classname:String: the name of the class required.

setClasspath	back to summary
public void setClasspath(Path classpath) Set the classpath to be used when searching for classes and resources. Parameters classpath:Path an Ant Path object containing the search path.

setClasspath

back to summary

public void setClasspath(Path classpath)

Set the classpath to be used when searching for classes and resources.

Parameters

classpath:Path: an Ant Path object containing the search path.

setClasspathRef	back to summary
public void setClasspathRef(Reference r) Set the classpath by reference. Parameters r:Reference a Reference to a Path instance to be used as the classpath value.

setClasspathRef

back to summary

public void setClasspathRef(Reference r)

Set the classpath by reference.

Parameters

r:Reference: a Reference to a Path instance to be used as the classpath value.

setFile	back to summary
public void setFile(File file) Set the file which must be present in the file system to set the given property. Parameters file:File the name of the file which is required.

setFile

back to summary

public void setFile(File file)

Set the file which must be present in the file system to set the given property.

Parameters

file:File: the name of the file which is required.

setFilepath	back to summary
public void setFilepath(Path filepath) Set the path to use when looking for a file. Parameters filepath:Path a Path instance containing the search path for files.

setFilepath

back to summary

public void setFilepath(Path filepath)

Set the path to use when looking for a file.

Parameters

filepath:Path: a Path instance containing the search path for files.

setIgnoresystemclasses	back to summary
public void setIgnoresystemclasses(boolean ignore) Set whether the search for classes should ignore the runtime classes and just use the given classpath. Parameters ignore:boolean true if system classes are to be ignored.

setIgnoresystemclasses

back to summary

public void setIgnoresystemclasses(boolean ignore)

Set whether the search for classes should ignore the runtime classes and just use the given classpath.

Parameters

ignore:boolean: true if system classes are to be ignored.

setProperty	back to summary
public void setProperty(String property) Set the name of the property which will be set if the particular resource is available. Parameters property:String the name of the property to set.

setProperty

back to summary

public void setProperty(String property)

Set the name of the property which will be set if the particular resource is available.

Parameters

property:String: the name of the property to set.

setResource	back to summary
public void setResource(String resource) Set the name of a Java resource which is required to set the property. Parameters resource:String the name of a resource which is required to be available.

setResource

back to summary

public void setResource(String resource)

Set the name of a Java resource which is required to set the property.

Parameters

resource:String: the name of a resource which is required to be available.

setSearchParents	back to summary
public void setSearchParents(boolean searchParents) Set the searchParents attribute. This controls the behaviour of the the "file" type. If true, the path, parent path and grandparent path are searched for the file. If false, only the path is searched. The default value is false. Parameters searchParents:boolean the value to set.

setSearchParents

back to summary

public void setSearchParents(boolean searchParents)

Set the searchParents attribute. This controls the behaviour of the the "file" type. If true, the path, parent path and grandparent path are searched for the file. If false, only the path is searched. The default value is false.

Parameters

searchParents:boolean: the value to set.

setType	back to summary
public void setType(String type) Deprecated since 1.5.x. 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. Parameters type:String the type of resource Annotations @Deprecated

setType	back to summary
public void setType(Available.FileDir type) Set what type of file is required - either directory or file. Parameters type:Available.FileDir an instance of the FileDir enumeratedAttribute indicating whether the file required is to be a directory or a plain file.

setType

back to summary

public void setType(Available.FileDir type)

Set what type of file is required - either directory or file.

Parameters

type:Available.FileDir: an instance of the FileDir enumeratedAttribute indicating whether the file required is to be a directory or a plain file.

setValue	back to summary
public void setValue(Object value) Set the value to be given to the property if the desired resource is available. Parameters value:Object the value to be given.

setValue

back to summary

public void setValue(Object value)

Set the value to be given to the property if the desired resource is available.

Parameters

value:Object: the value to be given.

setValue	back to summary
public void setValue(String value) Set the value to be given to the property if the desired resource is available. Parameters value:String the value to be given.

setValue

back to summary

public void setValue(String value)

Set the value to be given to the property if the desired resource is available.

Parameters

value:String: the value to be given.

org.apache.tools.ant.taskdefs back to summary

public Class Available.FileDir

Class Inheritance

extends EnumeratedAttribute

java.lang.Object
org.apache.tools.ant.types.EnumeratedAttribute
org.apache.tools.ant.taskdefs.Available.FileDir

EnumeratedAttribute covering the file types to be checked for, either file or dir.

Field Summary

Modifier and Type	Field and Description
private static final String[]	VALUES

Inherited from org.apache.tools.ant.types.EnumeratedAttribute:: value

Constructor Summary

Access	Constructor and Description
public	FileDir()

Method Summary

Modifier and Type	Method and Description
public String[]	getValues() Implements abstract org.apache.tools.ant.types.EnumeratedAttribute.getValues. This is the only method a subclass needs to implement.
public boolean	Returns: true if the value specifies a directory. isDir() Indicate if the value specifies a directory.
public boolean	Returns: true if the value specifies a file. isFile() Indicate if the value specifies a file.

Inherited from org.apache.tools.ant.types.EnumeratedAttribute:: containsValue getIndex getInstance getValue indexOfValue setValue toString

Field Detail

VALUES	back to summary
private static final String[] VALUES

Constructor Detail

FileDir	back to summary
public FileDir()

Method Detail

getValues back to summary

getValues	back to summary
public String[] getValues() Implements abstract org.apache.tools.ant.types.EnumeratedAttribute.getValues. Doc from org.apache.tools.ant.types.EnumeratedAttribute.getValues. This is the only method a subclass needs to implement. Returns:String[] an array holding all possible values of the enumeration. The order of elements must be fixed so that `indexOfValue(String)` always return the same index for the same value. Annotations @Override See Also `.`

public String[] getValues()

Implements abstract org.apache.tools.ant.types.EnumeratedAttribute.getValues.

Doc from org.apache.tools.ant.types.EnumeratedAttribute.getValues.

This is the only method a subclass needs to implement.

Returns:String[]

an array holding all possible values of the enumeration. The order of elements must be fixed so that indexOfValue(String) always return the same index for the same value.

Annotations

@Override

See Also

.

isDir	back to summary
public boolean isDir() Indicate if the value specifies a directory. Returns:boolean true if the value specifies a directory.

isDir

back to summary

public boolean isDir()

Indicate if the value specifies a directory.

Returns:boolean: true if the value specifies a directory.

isFile	back to summary
public boolean isFile() Indicate if the value specifies a file. Returns:boolean true if the value specifies a file.

isFile

back to summary

public boolean isFile()

Indicate if the value specifies a file.

Returns:boolean: true if the value specifies a file.

public Class Available

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Available.FileDir

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail