hudson.plugins.clearcase.util

Class DeleteOnCloseFileInputStream

java.lang.Object

java.io.InputStream

java.io.FileInputStream

hudson.plugins.clearcase.util.DeleteOnCloseFileInputStream

All Implemented Interfaces:

Closeable, AutoCloseable

public class DeleteOnCloseFileInputStream
extends FileInputStream

A FileInputStream which (optionally) deletes the underlying file when the stream is closed. A modified version of the class implemented by BJ in his blog, ref http://bimalesh.blogspot.com/2010/02/auto-deleting-fileinputstream.html

Author:

BJ, Christophe Guillon

Field Summary

Fields

Modifier and Type	Field and Description
protected Logger	logger Logger if defined

Constructor Summary

Constructors

Constructor and Description
DeleteOnCloseFileInputStream(File file) Creates a fileInputStream wrapped around the given file and deletes the file when the FileInputStream is closed.
DeleteOnCloseFileInputStream(File file, boolean deleteOnClose) Creates a fileInputStream wrapped around the given file.
DeleteOnCloseFileInputStream(String name) Creates a fileInputStream for the given file name and deletes the file when the FileInputStream is closed.

Method Summary

Modifier and Type	Method and Description
void	close() Closes the underlying FileInputStream and also deletes the file object from disk if the isDeleteOnClose() is set to true.
protected void	finalize() Ensures that the close method of this file input stream is called when there are no more references to it.
boolean	isDeleteOnClose()
void	setLogger(Logger logger) Set logger.

Methods inherited from class java.io.FileInputStream

available, getChannel, getFD, read, read, read, skip

Methods inherited from class java.io.InputStream

mark, markSupported, reset

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected Logger logger

Logger if defined

Constructor Detail

DeleteOnCloseFileInputStream

public DeleteOnCloseFileInputStream(File file)
                             throws FileNotFoundException

Creates a fileInputStream wrapped around the given file and deletes the file when the FileInputStream is closed.

Parameters:

file - an opened file

Throws:

FileNotFoundException

DeleteOnCloseFileInputStream

public DeleteOnCloseFileInputStream(File file,
                                    boolean deleteOnClose)
                             throws FileNotFoundException

Creates a fileInputStream wrapped around the given file.

Parameters:

file - the filename that will be opened for input

deleteOnClose - set to true for activating deletion on close

Throws:

FileNotFoundException

DeleteOnCloseFileInputStream

public DeleteOnCloseFileInputStream(String name)
                             throws FileNotFoundException

Creates a fileInputStream for the given file name and deletes the file when the FileInputStream is closed.

Parameters:

name - the filename that will be opened for input

Throws:

FileNotFoundException

Method Detail

close

public void close()
           throws IOException

Closes the underlying FileInputStream and also deletes the file object from disk if the isDeleteOnClose() is set to true.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Overrides:

close in class FileInputStream

Throws:

IOException

See Also:

FileInputStream.close()

isDeleteOnClose

public final boolean isDeleteOnClose()

Returns:

boolean flag, true if the file should be deleted on close(). Default is true.

setLogger

public void setLogger(Logger logger)

Set logger.

Parameters:

logger - logger to use

finalize

protected void finalize()
                 throws IOException

Ensures that the close method of this file input stream is called when there are no more references to it.

Overrides:

finalize in class FileInputStream

Throws:

IOException - if an I/O error occurs.