org.frameworkset.util

Interface BigFile

public interface BigFile

BigFile.java

Description:

bboss workgroup

Copyright (c) 2009

Method Summary

Modifier and Type	Method and Description
byte[]	getBytes() Return the contents of the file as an array of bytes.
java.lang.String	getContentType() Return the content type of the file.
java.io.InputStream	getInputStream() Return an InputStream to read the contents of the file from.
java.lang.String	getOriginalFilename() Return the original filename in the client's filesystem.
long	getSize() Return the size of the file in bytes.
boolean	isEmpty() Return whether the uploaded file is empty, that is, either no file has been chosen in the multipart form or the chosen file has no content.
void	transferTo(java.io.File dest) Transfer the received file to the given destination file.

Method Detail

getOriginalFilename

java.lang.String getOriginalFilename()

Return the original filename in the client's filesystem.

This may contain path information depending on the browser used, but it typically will not with any other than Opera.

Returns:

the original filename, or the empty String if no file has been chosen in the multipart form

getContentType

java.lang.String getContentType()

Return the content type of the file.

Returns:

the content type, or null if not defined (or no file has been chosen in the multipart form)

isEmpty

boolean isEmpty()

Return whether the uploaded file is empty, that is, either no file has been chosen in the multipart form or the chosen file has no content.

getSize

long getSize()

Return the size of the file in bytes.

Returns:

the size of the file, or 0 if empty

getBytes

byte[] getBytes()
         throws java.io.IOException

Return the contents of the file as an array of bytes.

Returns:

the contents of the file as bytes, or an empty byte array if empty

Throws:

java.io.IOException - in case of access errors (if the temporary store fails)

getInputStream

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

Return an InputStream to read the contents of the file from. The user is responsible for closing the stream.

Returns:

the contents of the file as stream, or an empty stream if empty

Throws:

java.io.IOException - in case of access errors (if the temporary store fails)

transferTo

void transferTo(java.io.File dest)
         throws java.io.IOException,
                java.lang.IllegalStateException

Transfer the received file to the given destination file.

This may either move the file in the filesystem, copy the file in the filesystem, or save memory-held contents to the destination file. If the destination file already exists, it will be deleted first.

If the file has been moved in the filesystem, this operation cannot be invoked again. Therefore, call this method just once to be able to work with any storage mechanism.

Parameters:

dest - the destination file

Throws:

java.io.IOException - in case of reading or writing errors

java.lang.IllegalStateException - if the file has already been moved in the filesystem and is not available anymore for another transfer