org.apache.tools.ant.taskdefs

Class TempFile

public class TempFile extends Task

This task sets a property to the name of a temporary file. Unlike File#createTempFile, this task does not (by default) 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

UNKNOWN:

Method Summary
voidexecute()
Creates the temporary file.
booleanisCreateFile()
Learn whether createFile flag is set for this tempfile task.
booleanisDeleteOnExit()
Learn whether deleteOnExit is set for this tempfile task.
voidsetCreateFile(boolean createFile)
If set the file is actually created, if not just a name is created.
voidsetDeleteOnExit(boolean deleteOnExit)
Set whether the tempfile created by this task should be set for deletion on normal VM exit.
voidsetDestDir(File destDir)
Sets the destination directory.
voidsetPrefix(String prefix)
Sets the optional prefix string for the temp file.
voidsetProperty(String property)
Sets the property you wish to assign the temporary file to.
voidsetSuffix(String suffix)
Sets the optional suffix string for the temp file.

Method Detail

execute

public void execute()
Creates the temporary file.

Throws: BuildException if something goes wrong with the build

isCreateFile

public boolean isCreateFile()
Learn whether createFile flag is set for this tempfile task.

Returns: the createFile flag.

isDeleteOnExit

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

Returns: boolean deleteOnExit flag.

setCreateFile

public void setCreateFile(boolean createFile)
If set the file is actually created, if not just a name is created.

Parameters: createFile boolean 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

UNKNOWN: group="required"

setSuffix

public void setSuffix(String suffix)
Sets the optional suffix string for the temp file.

Parameters: suffix suffix including any "." , e.g ".xml"