com.github.quintans.ezSQL.toolkit.io

Class BinStore

java.lang.Object

com.github.quintans.ezSQL.toolkit.io.BinStore

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

TextStore

public class BinStore
extends Object
implements Serializable

This is an adaptation of org.apache.commons.fileupload.disk.DiskFileItem.java

After retrieving an instance of this class, you may either request all contents of file at once using get() or request an InputStream with getInputStream() and process the file without attempting to load it into memory, which may come handy with large files.

Temporary files, which are created for file items, should be deleted later on. However, if you do use such a tracker, then you must consider the following: Temporary files are automatically deleted as soon as they are no longer needed. (More precisely, when the corresponding instance of File is garbage collected.)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_THRESHOLD

Constructor Summary

Constructors

Constructor and Description
BinStore()
BinStore(byte[] data)
BinStore(int sizeThreshold) Constructs a new BinStore instance.
BinStore(int sizeThreshold, byte[] data)

Method Summary

Modifier and Type	Method and Description
void	delete() Deletes the underlying storage for a file item, including deleting any associated temporary disk file.
protected void	finalize() Removes the file contents from the temporary storage.
byte[]	get() Returns the contents of the file as an array of bytes.
InputStream	getInputStream() Returns an InputStream that can be used to retrieve the contents of the file.
OutputStream	getOutputStream()
OutputStream	getOutputStream(File directory) Returns an OutputStream that can be used for storing the contents of the file.
long	getSize() Returns the size of the file.
File	getStoreLocation() Returns the File object for the FileItem's data's temporary location on the disk.
protected File	getTempFile(File directory) Creates and returns a File representing a uniquely named temporary file in the configured repository path.
boolean	isInMemory() Provides a hint as to whether or not the file contents will be read from memory.
void	set(byte[] data) Sets the contents using an array of bytes as a source
void	set(File source) Sets the contents using a File as a source
void	set(InputStream source) Sets the contents using a InputStream as a source
String	toString() Returns a string representation of this object.
void	write(File file) A convenience method to write an uploaded item to disk.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_THRESHOLD

public static final int DEFAULT_THRESHOLD

See Also:

Constant Field Values

Constructor Detail

BinStore

public BinStore()

BinStore

public BinStore(byte[] data)

BinStore

public BinStore(int sizeThreshold,
                byte[] data)

BinStore

public BinStore(int sizeThreshold)

Constructs a new BinStore instance.

Parameters:

sizeThreshold - The threshold, in bytes, below which items will be retained in memory and above which they will be stored as a file.

Method Detail

getInputStream

public InputStream getInputStream()
                           throws IOException

Returns an InputStream that can be used to retrieve the contents of the file.

Returns:

An InputStream that can be used to retrieve the contents of the file.

Throws:

IOException - if an error occurs.

isInMemory

public boolean isInMemory()

Provides a hint as to whether or not the file contents will be read from memory.

Returns:

true if the file contents will be read from memory; false otherwise.

getSize

public long getSize()

Returns the size of the file.

Returns:

The size of the file, in bytes.

get

public byte[] get()

Returns the contents of the file as an array of bytes. If the contents of the file were not yet cached in memory, they will be loaded from the disk storage and cached.

Returns:

The contents of the file as an array of bytes.

set

public void set(byte[] data)

Sets the contents using an array of bytes as a source

Parameters:

data - The array of bytes with the data

set

public void set(File source)
         throws IOException

Sets the contents using a File as a source

Parameters:

source - The file with the data

Throws:

IOException

set

public void set(InputStream source)
         throws IOException

Sets the contents using a InputStream as a source

Parameters:

source - The InputStream with the data

Throws:

IOException

write

public void write(File file)
           throws Exception

A convenience method to write an uploaded item to disk. The client code is not concerned with whether or not the item is stored in memory, or on disk in a temporary location. They just want to write the uploaded item to a file.

This implementation first attempts to rename the uploaded item to the specified destination file, if the item was originally written to disk. Otherwise, the data will be copied to the specified file.

This method is only guaranteed to work once, the first time it is invoked for a particular item. This is because, in the event that the method renames a temporary file, that file will no longer be available to copy or rename again at a later time.

Parameters:

file - The File into which the uploaded item should be stored.

Throws:

Exception - if an error occurs.

delete

public void delete()

Deletes the underlying storage for a file item, including deleting any associated temporary disk file. Although this storage will be deleted automatically when the FileItem instance is garbage collected, this method can be used to ensure that this is done at an earlier time, thus preserving system resources.

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Throws:

IOException

getOutputStream

public OutputStream getOutputStream(File directory)
                             throws IOException

Returns an OutputStream that can be used for storing the contents of the file.

Parameters:

directory - The directory where the temporary file is created.
If null it's created in the default directory.

Returns:

An OutputStream that can be used for storing the contents of the file.

Throws:

IOException - if an error occurs.

getStoreLocation

public File getStoreLocation()

Returns the File object for the FileItem's data's temporary location on the disk. Note that for FileItems that have their data stored in memory, this method will return null. When handling large files, you can use File.renameTo(java.io.File) to move the file to new location without copying the data, if the source and destination locations reside within the same logical volume.

Returns:

The data file, or null if the data is stored in memory.

finalize

protected void finalize()

Removes the file contents from the temporary storage.

Overrides:

finalize in class Object

getTempFile

protected File getTempFile(File directory)

Creates and returns a File representing a uniquely named temporary file in the configured repository path. The lifetime of the file is tied to the lifetime of the FileItem instance; the file will be deleted when the instance is garbage collected.

Parameters:

directory - The directory where this temporary file is created

Returns:

The File to be used for temporary storage.

toString

public String toString()

Returns a string representation of this object.

Overrides:

toString in class Object

Returns:

a string representation of this object.