org.oddjob.io

Class DeleteJob

java.lang.Object

org.oddjob.io.DeleteJob

All Implemented Interfaces:

java.io.Serializable, java.util.concurrent.Callable<java.lang.Integer>

public class DeleteJob
extends java.lang.Object
implements java.util.concurrent.Callable<java.lang.Integer>, java.io.Serializable

Description

Delete a file or directory, or files and directories.

Unless the force property is set, this job will cause an exception if an attempt is made to delete a non empty directory.

Example

Delete all files from a directory. The directory is the first of Oddjob's arguments.

<oddjob id="this">
    <job>
        <delete id="delete">
            <files>
                <files files="${this.args[0]}/*"/>
            </files>
        </delete>
    </job>
</oddjob>

See Also:

Serialized Form

Author:

Rob Gordon

Constructor Summary

Constructors

Constructor and Description
DeleteJob()

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	call()
protected void	deleteFile(java.io.File fileToDelete)
int	getDirCount()
int	getErrorCount()
int	getFileCount()
java.io.File[]	getFiles() Get the files.
int	getLogEvery()
int	getMaxErrors()
java.lang.String	getName() Get the name.
boolean	isForce() Getter for force property.
boolean	isReallyRoot()
protected boolean	isRoot(java.io.File fileToDelete)
void	reset()
void	setFiles(java.io.File[] files) Set the files.
void	setForce(boolean force) Setter for force property.
void	setLogEvery(int logEvery)
void	setMaxErrors(int maxErrors)
void	setName(java.lang.String name) Set the name
void	setReallyRoot(boolean reallyRoot)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteJob

public DeleteJob()

Method Detail

call

public java.lang.Integer call()
                       throws java.io.IOException,
                              java.lang.InterruptedException

Specified by:

call in interface java.util.concurrent.Callable<java.lang.Integer>

Throws:

java.io.IOException

java.lang.InterruptedException

deleteFile

protected void deleteFile(java.io.File fileToDelete)
                   throws java.io.IOException

Throws:

java.io.IOException

isRoot

protected boolean isRoot(java.io.File fileToDelete)

reset

public void reset()

getName

public java.lang.String getName()

Get the name.

Returns:

The name.

setName

public void setName(java.lang.String name)

Set the name

Parameters:

name - The name.

getFiles

public java.io.File[] getFiles()

Get the files.

Returns:

The files.

setFiles

public void setFiles(java.io.File[] files)

Set the files.

Parameters:

files - The files.

isForce

public boolean isForce()

Getter for force property.

Returns:

The force property.

setForce

public void setForce(boolean force)

Setter for force property.

Parameters:

force - The force property.

setLogEvery

public void setLogEvery(int logEvery)

getLogEvery

public int getLogEvery()

setReallyRoot

public void setReallyRoot(boolean reallyRoot)

isReallyRoot

public boolean isReallyRoot()

getFileCount

public int getFileCount()

getDirCount

public int getDirCount()

getErrorCount

public int getErrorCount()

getMaxErrors

public int getMaxErrors()

setMaxErrors

public void setMaxErrors(int maxErrors)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object