org.apache.commons.io

类 FileDeleteStrategy

java.lang.Object

org.apache.commons.io.FileDeleteStrategy

public class FileDeleteStrategy
extends Object

Strategy for deleting files.

There is more than one way to delete a file. You may want to limit access to certain directories, to only delete directories if they are empty, or maybe to force deletion.

This class captures the strategy to use and is designed for user subclassing.

从以下版本开始:

1.3

字段概要

字段

限定符和类型	字段和说明
static FileDeleteStrategy	FORCE The singleton instance for forced file deletion, which always deletes, even if the file represents a non-empty directory.
static FileDeleteStrategy	NORMAL The singleton instance for normal file deletion, which does not permit the deletion of directories that are not empty.

构造器概要

构造器

限定符	构造器和说明
protected	FileDeleteStrategy(String name) Restricted constructor.

方法概要

限定符和类型	方法和说明
void	delete(File fileToDelete) Deletes the file object, which may be a file or a directory.
boolean	deleteQuietly(File fileToDelete) Deletes the file object, which may be a file or a directory.
protected boolean	doDelete(File fileToDelete) Actually deletes the file object, which may be a file or a directory.
String	toString() Gets a string describing the delete strategy.

从类继承的方法 java.lang.Object

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

字段详细资料

NORMAL

public static final FileDeleteStrategy NORMAL

The singleton instance for normal file deletion, which does not permit the deletion of directories that are not empty.

FORCE

public static final FileDeleteStrategy FORCE

The singleton instance for forced file deletion, which always deletes, even if the file represents a non-empty directory.

构造器详细资料

FileDeleteStrategy

protected FileDeleteStrategy(String name)

Restricted constructor.

参数:

name - the name by which the strategy is known

方法详细资料

deleteQuietly

public boolean deleteQuietly(File fileToDelete)

Deletes the file object, which may be a file or a directory. All IOExceptions are caught and false returned instead. If the file does not exist or is null, true is returned.

Subclass writers should override doDelete(File), not this method.

参数:

fileToDelete - the file to delete, null returns true

返回:

true if the file was deleted, or there was no such file

delete

public void delete(File fileToDelete)
            throws IOException

Deletes the file object, which may be a file or a directory. If the file does not exist, the method just returns.

Subclass writers should override doDelete(File), not this method.

参数:

fileToDelete - the file to delete, not null

抛出:

NullPointerException - if the file is null

IOException - if an error occurs during file deletion

doDelete

protected boolean doDelete(File fileToDelete)
                    throws IOException

Actually deletes the file object, which may be a file or a directory.

This method is designed for subclasses to override. The implementation may return either false or an IOException when deletion fails. The delete(File) and deleteQuietly(File) methods will handle either response appropriately. A check has been made to ensure that the file will exist.

This implementation uses File.delete().

参数:

fileToDelete - the file to delete, exists, not null

返回:

true if the file was deleteds

抛出:

NullPointerException - if the file is null

IOException - if an error occurs during file deletion

toString

public String toString()

Gets a string describing the delete strategy.

覆盖:

toString 在类中 Object

返回:

a string describing the delete strategy