com.hfg.anttask

Class FileProperty

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

com.hfg.anttask.FileProperty

All Implemented Interfaces:

Cloneable

public class FileProperty
extends org.apache.tools.ant.Task

Ant task for assigning a file to a property.

Description

If the specified file exists, this task sets the properties <name>, <name>.name, <name>.wildcard, in the project. Properties are case sensitive.

Normally, this task is used with files whose names contain a variable portion, the matching of which is facilitated by a PatternSet which allows '*' and '?' wildcarding (see Ant's documentation).

If multiple files are found which match the file pattern, a BuildException is thrown.

Parameters

Parameter descriptions

Attribute	Description	Required
name	The name (handle) of the property.	Yes
dir	The directory containing the file. If not set, it defaults to the current directory.	Yes
file	The name of the file (may contain wildcards). If not set, a directory is searched for in place of a file.
if	Only execute if a property of the given name exists in the current project.	No
unless	Only execute if a property of the given name doesn't exist in the current project.	No

The if and unless attributes make the execution conditional -both probe for the named property being defined. The if tests for the property being defined, the unless for a property being undefined.

If both attributes are set, then the task executes only if both tests are true. i.e.

execute := defined(ifProperty) && !defined(unlessProperty)

Examples

If ${lib.dir} contained the file commons-net-20040324.jar

 <fileproperty name='commons_net' dir='${lib.dir}' file='commons-net-*.jar' />
 

would set the commons_net property to ${lib.dir}/commons-net-20040324.jar, the commons_net.name property to commons-net-20040324.jar, the commons_net.wildcard property to 20040324

Field Summary

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

target, taskName, taskType, wrapper

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

description, location, project

Constructor Summary

Constructors

Constructor and Description
FileProperty()

Method Summary

Modifier and Type	Method and Description
void	execute()
void	setDebug(String inValue)
void	setDir(File dir)
void	setFile(String file)
void	setIf(String inPropertyName) Only execute if a property of the given name exists in the current project
void	setName(String name)
void	setUnless(String inPropertyName) Only execute if a property of the given name does not exist in the current project

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, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileProperty

public FileProperty()

Method Detail

setName

public void setName(String name)

setFile

public void setFile(String file)

setDir

public void setDir(File dir)
            throws org.apache.tools.ant.BuildException

Throws:

org.apache.tools.ant.BuildException

setDebug

public void setDebug(String inValue)
              throws org.apache.tools.ant.BuildException

Throws:

org.apache.tools.ant.BuildException

setIf

public void setIf(String inPropertyName)

Only execute if a property of the given name exists in the current project

Parameters:

inPropertyName - property name

setUnless

public void setUnless(String inPropertyName)

Only execute if a property of the given name does not exist in the current project

Parameters:

inPropertyName - property name

execute

public void execute()
             throws org.apache.tools.ant.BuildException

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException