com.technia.tvc.core.io

Class TempFile

java.lang.Object

com.technia.tvc.core.io.TempFile

public class TempFile
extends java.lang.Object

Represents a temporary file on the local file system.

Since:

6.1

Constructor Summary

Constructors

Constructor and Description
TempFile(java.io.File dir, java.lang.String prefix, java.lang.String suffix) Creates a temporary file on the file system.
TempFile(java.lang.String prefix, java.lang.String suffix) Creates a temporary file on the file system.

Method Summary

Modifier and Type	Method and Description
protected void	checkReleased() Ensures that this instance has not been released.
java.io.File	getFile() Returns the temporary file.
java.io.InputStream	getInputStream() Returns an InputStream that can be used to read the content of the temp file.
java.io.InputStream	getInputStream(boolean deleteOnClose) Returns an InputStream that can be used to read the content of the temp file.
java.io.OutputStream	getOutputStream() Calling this method, is same as doing:
java.io.OutputStream	getOutputStream(boolean buffered) Creates an outputstream that can be used to write data into the underlying temporary file.
void	release() Delete the temporary file from the local file system.

Methods inherited from class java.lang.Object

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

Constructor Detail

TempFile

public TempFile(java.lang.String prefix,
                java.lang.String suffix)
         throws java.io.IOException

Creates a temporary file on the file system.

Throws:

java.lang.IllegalArgumentException - If the prefix argument contains fewer than three characters

java.io.IOException - If a file could not be created

See Also:

File.createTempFile(String,String,File)

TempFile

public TempFile(java.io.File dir,
                java.lang.String prefix,
                java.lang.String suffix)
         throws java.io.IOException

Creates a temporary file on the file system.

Throws:

java.lang.IllegalArgumentException - If the prefix argument contains fewer than three characters

java.io.IOException - If a file could not be created

See Also:

File.createTempFile(String,String,File)

Method Detail

getOutputStream

public java.io.OutputStream getOutputStream()
                                     throws java.io.IOException

Calling this method, is same as doing:

 return getOutputStream(false);
 

Returns:

An (un-buffered) output stream

Throws:

java.io.IOException

Since:

2012.3.0

See Also:

getOutputStream(boolean)

getOutputStream

public java.io.OutputStream getOutputStream(boolean buffered)
                                     throws java.io.IOException

Creates an outputstream that can be used to write data into the underlying temporary file.

Parameters:

buffered - True if to create a buffered output stream

Returns:

An Outputstream that can be used to write into the underlying temp file

Throws:

java.io.IOException - If unable to create the output stream due to IO errors

Since:

2012.3.0

getFile

public java.io.File getFile()

Returns the temporary file.

Throws:

java.lang.IllegalStateException - If this instance has been released.

checkReleased

protected void checkReleased()

Ensures that this instance has not been released. If that is the case, an IllegalStateException will be thrown.

Throws:

java.lang.IllegalStateException - If this instance has been released.

release

public void release()

Delete the temporary file from the local file system.

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException

Returns an InputStream that can be used to read the content of the temp file.

This method does getInputStream(false);

Returns:

An InputStream for reading the content of the temp file.

Throws:

java.io.IOException

See Also:

getInputStream(boolean)

getInputStream

public java.io.InputStream getInputStream(boolean deleteOnClose)
                                   throws java.io.IOException

Returns an InputStream that can be used to read the content of the temp file.

If the deleteOnClose argument is true, the temp file is deleted when the close method is called on the InputStream.

Parameters:

deleteOnClose - Defines if the temp file should be deleted upon closing the input stream.

Returns:

An InputStream for reading the content of the temp file.

Throws:

java.io.IOException