wt.util
Class TempFileOutputStream

java.lang.Object
  extended byjava.io.OutputStream
      extended bywt.util.TempFileOutputStream

public class TempFileOutputStream
extends OutputStream

This class is designed to be used much like a ByteArrayOutputStream, the primary difference being that output is written to a temporary file as oppose to consuming memory with a byte array.

Note: The dispose method should be called to delete the temporary file and free all related resources when no longer needed.

Supported API: true
Extendable: false


Field Summary
private static int bufSiz
           
private static boolean DEBUG
           
(package private)  File f
           
(package private)  int length
           
(package private)  RandomAccessFile raf
           
private static String TEMPDIR
           
private static String versionID
           
 
Constructor Summary
TempFileOutputStream()
          Construct a new TempFileOutputStream object.
TempFileOutputStream(int buffer_size)
          Construct a new TempFileOutputStream object specifying the write buffer size.
 
Method Summary
 void dispose()
          Dispose of resources associated with this TempFileOutputStream.
protected  void finialize()
          finialize this object, cleans up temp file resources if dispose is never called.
private static int getBufSiz()
           
 int getLength()
          Get the size of the temporary file.
static void main(String[] args)
          Test driver (main)

Supported API: true
private  void readInputFile(String file_name, TempFileOutputStream tf)
           
 int size()
          Get the size of the temporary file.
 void write(byte[] b)
          Writes b.length bytes to this TempFileOutputStream.
 void write(byte[] b, int off, int len)
          Write data to this TempFileOutputStream.
 void write(int b)
          Write data to this TempFileOutputStream.
 void writeTo(OutputStream os)
          Write temp file data to some OutputStream.
 
Methods inherited from class java.io.OutputStream
close, flush
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

f

File f

raf

RandomAccessFile raf

length

int length

versionID

private static final String versionID
See Also:
Constant Field Values

TEMPDIR

private static final String TEMPDIR

DEBUG

private static final boolean DEBUG

bufSiz

private static int bufSiz
Constructor Detail

TempFileOutputStream

public TempFileOutputStream()
                     throws IOException
Construct a new TempFileOutputStream object.

Supported API: true

Throws:
IOException - If unable to open the temporary file.

TempFileOutputStream

public TempFileOutputStream(int buffer_size)
                     throws IOException
Construct a new TempFileOutputStream object specifying the write buffer size.

Supported API: true

Parameters:
buffer_size -
Throws:
IOException - If unable to open the temporary file.
Method Detail

size

public int size()
Get the size of the temporary file.

Supported API: true

Returns:
the size of the temporary file

getLength

public int getLength()
Get the size of the temporary file.

Supported API: true

Returns:
the size of the temporary file

write

public void write(byte[] b,
                  int off,
                  int len)
           throws IOException
Write data to this TempFileOutputStream.

Supported API: true

Parameters:
b - a byte array of data to be written to temporary file
off - offset into the byte array
len - amout of data to be written
Throws:
IOException - if a write error occurs.

write

public void write(int b)
           throws IOException
Write data to this TempFileOutputStream.

Supported API: true

Parameters:
b - a byte array of data to be written to temporary file
Throws:
IOException - if a write error occurs.

write

public void write(byte[] b)
           throws IOException
Writes b.length bytes to this TempFileOutputStream.

Supported API: true

Parameters:
b - a byte array of data to be written to temporary file
Throws:
IOException - if a write error occurs.

writeTo

public void writeTo(OutputStream os)
             throws IOException
Write temp file data to some OutputStream.

Supported API: true

Parameters:
os - OutputStream which is to recievie the temp files contents
Throws:
IOException - if a read or write error errors.

dispose

public void dispose()
Dispose of resources associated with this TempFileOutputStream. The temporary file is closed and deleted.

Supported API: true


finialize

protected void finialize()
                  throws Throwable
finialize this object, cleans up temp file resources if dispose is never called.

Throws:
Throwable

getBufSiz

private static int getBufSiz()

readInputFile

private void readInputFile(String file_name,
                           TempFileOutputStream tf)
                    throws Exception
Throws:
Exception

main

public static void main(String[] args)
Test driver (main)

Supported API: true