Overview Package Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

org.apache.tools.ant.taskdefs

Class TempFile

Implemented Interfaces:
Cloneable
public class TempFile
extends Task
This task sets a property to the name of a temporary file. Unlike File.createTempFile, this task does not actually create the temporary file, but it does guarantee that the file did not exist when the task was executed.

Examples 

<tempfile property="temp.file" />
create a temporary file 
<tempfile property="temp.file" suffix=".xml" />
create a temporary file with the .xml suffix. 
<tempfile property="temp.file" destDir="build"/>
create a temp file in the build subdir
Since:
Ant 1.5

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

Method Summary

void
execute()
Creates the temporary file.
boolean
isDeleteOnExit()
Learn whether deleteOnExit is set for this tempfile task.
void
setDeleteOnExit(boolean deleteOnExit)
Set whether the tempfile created by this task should be set for deletion on normal VM exit.
void
setDestDir(File destDir)
Sets the destination directory.
void
setPrefix(String prefix)
Sets the optional prefix string for the temp file.
void
setProperty(String property)
Sets the property you wish to assign the temporary file to.
void
setSuffix(String suffix)
Sets the optional suffix string for the temp file.

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

bindToOwner, execute, 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, log, log, setDescription, setLocation, setProject

Method Details

execute

public void execute()
            throws BuildException
Creates the temporary file.
Overrides:
execute in interface Task
Throws:
BuildException - if something goes wrong with the build

isDeleteOnExit

public boolean isDeleteOnExit()
Learn whether deleteOnExit is set for this tempfile task.
Returns:
boolean deleteOnExit flag.

setDeleteOnExit

public void setDeleteOnExit(boolean deleteOnExit)
Set whether the tempfile created by this task should be set for deletion on normal VM exit.
Parameters:
deleteOnExit - boolean flag.

setDestDir

public void setDestDir(File destDir)
Sets the destination directory. If not set, the basedir directory is used instead.
Parameters:
destDir - The new destDir value

setPrefix

public void setPrefix(String prefix)
Sets the optional prefix string for the temp file.
Parameters:
prefix - string to prepend to generated string

setProperty

public void setProperty(String property)
Sets the property you wish to assign the temporary file to.
Parameters:
property - The property to set

setSuffix

public void setSuffix(String suffix)
Sets the optional suffix string for the temp file.
Parameters:
suffix - suffix including any "." , e.g ".xml"

Overview Package Tree Index Deprecated About