Class TempFile

java.lang.Object

org.apache.tools.ant.ProjectComponent

org.apache.tools.ant.Task

org.apache.tools.ant.taskdefs.TempFile

All Implemented Interfaces:

Cloneable

public class TempFile
extends Task

This task sets a property to the name of a temporary file. Unlike File.createTempFile(String, String, File), 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

Field Summary

Fields inherited from class Task

target, taskName, taskType, wrapper

Modifier and Type	Field	Description
protected Target	target	Deprecated. since 1.6.x.
protected String	taskName	Deprecated. since 1.6.x.
protected String	taskType	Deprecated. since 1.6.x.
protected RuntimeConfigurable	wrapper	Deprecated. since 1.6.x.

Fields inherited from class ProjectComponent

description, location, project

Modifier and Type	Field	Description
protected String	description	Deprecated. since 1.6.x.
protected Location	location	Deprecated. since 1.6.x.
protected Project	project	Deprecated. since 1.6.x.

Constructor Summary

Constructors

Constructor	Description
TempFile()

Method Summary

Modifier and Type	Method	Description
void	execute()	Creates the temporary file.
boolean	isCreateFile()	Learn whether createFile flag is set for this tempfile task.
boolean	isDeleteOnExit()	Learn whether deleteOnExit is set for this tempfile task.
void	setCreateFile(boolean createFile)	If set the file is actually created, if not just a name is created.
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 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

Modifier and Type	Method	Description
final void	bindToOwner(Task owner)	Bind a task to another; use this when configuring a newly created task to do work on behalf of another.
Target	getOwningTarget()	Returns the container target of this task.
RuntimeConfigurable	getRuntimeConfigurableWrapper()	Returns the wrapper used for runtime configuration.
String	getTaskName()	Returns the name to use in logging messages.
String	getTaskType()	Return the type of task.
protected RuntimeConfigurable	getWrapper()	Return the runtime configurable structure for this task.
protected void	handleErrorFlush(String output)	Handles an error line by logging it with the WARN priority.
protected void	handleErrorOutput(String output)	Handles an error output by logging it with the WARN priority.
protected void	handleFlush(String output)	Handles output by logging it with the INFO priority.
protected int	handleInput(byte[] buffer, int offset, int length)	Handle an input request by this task.
protected void	handleOutput(String output)	Handles output by logging it with the INFO priority.
void	init()	Called by the project to let the task initialize properly.
protected final boolean	isInvalid()	Has this task been marked invalid?
void	log(String msg)	Logs a message with the default (INFO) priority.
void	log(String msg, int msgLevel)	Logs a message with the given priority.
void	log(String msg, Throwable t, int msgLevel)	Logs a message with the given priority.
void	log(Throwable t, int msgLevel)	Logs a message with the given priority.
void	maybeConfigure()	Configures this task - if it hasn't been done already.
final void	perform()	Performs this task if it's still valid, or gets a replacement version and performs that otherwise.
void	reconfigure()	Force the task to be reconfigured from its RuntimeConfigurable.
void	setOwningTarget(Target target)	Sets the target container of this task.
void	setRuntimeConfigurableWrapper(RuntimeConfigurable wrapper)	Sets the wrapper to be used for runtime configuration.
void	setTaskName(String name)	Sets the name to use in logging messages.
void	setTaskType(String type)	Sets the name with which the task has been invoked.

Methods inherited from class ProjectComponent

clone, getDescription, getLocation, getProject, setDescription, setLocation, setProject

Modifier and Type	Method	Description
Object	clone()
String	getDescription()	Returns the description of the current action.
Location	getLocation()	Returns the file/location where this task was defined.
Project	getProject()	Returns the project to which this component belongs.
void	setDescription(String desc)	Sets a description of the current action.
void	setLocation(Location location)	Sets the file/location where this task was defined.
void	setProject(Project project)	Sets the project object of this component.

Methods inherited from class Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

TempFile

public TempFile()

Method Details

setProperty

public void setProperty(String property)

Sets the property you wish to assign the temporary file to.

Parameters:

property - The property to set

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

setSuffix

public void setSuffix(String suffix)

Sets the optional suffix string for the temp file.

Parameters:

suffix - suffix including any ".", e.g ".xml"

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.

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.

isCreateFile

public boolean isCreateFile()

Learn whether createFile flag is set for this tempfile task.

Returns:

the createFile flag.

execute

public void execute()
             throws BuildException

Creates the temporary file.

Overrides:

execute in class Task

Throws:

BuildException - if something goes wrong with the build