org.apache.struts.upload

Interface FormFile

public interface FormFile

This interface represents a file that has been uploaded by a client. It is the only interface or class in upload package which is typically referenced directly by a Struts application.
Method Summary
voiddestroy()
Destroys all content for the uploaded file, including any underlying data files.
StringgetContentType()
Returns the content type for this file.
byte[]getFileData()
Returns the data for the entire file as byte array.
StringgetFileName()
Returns the file name of this file.
intgetFileSize()
Returns the size of this file.
InputStreamgetInputStream()
Returns an input stream for this file.
voidsetContentType(String contentType)
Sets the content type for this file.
voidsetFileName(String fileName)
Sets the file name of this file.
voidsetFileSize(int fileSize)
Sets the file size.

Method Detail

destroy

public void destroy()
Destroys all content for the uploaded file, including any underlying data files.

getContentType

public String getContentType()
Returns the content type for this file.

Returns: A String representing content type.

getFileData

public byte[] getFileData()
Returns the data for the entire file as byte array. Care is needed when using this method, since a large upload could easily exhaust available memory. The preferred method for accessing the file data is getInputStream.

Returns: The file data as a byte array.

Throws: FileNotFoundException if the uploaded file is not found. IOException if an error occurred while reading the file.

getFileName

public String getFileName()
Returns the file name of this file. This is the base name of the file, as supplied by the user when the file was uploaded.

Returns: The base file name.

getFileSize

public int getFileSize()
Returns the size of this file.

Returns: The size of the file, in bytes.

getInputStream

public InputStream getInputStream()
Returns an input stream for this file. The caller must close the stream when it is no longer needed.

Throws: FileNotFoundException if the uploaded file is not found. IOException if an error occurred while reading the file.

setContentType

public void setContentType(String contentType)
Sets the content type for this file.

Parameters: contentType The content type for the file.

setFileName

public void setFileName(String fileName)
Sets the file name of this file.

Parameters: fileName The base file name.

setFileSize

public void setFileSize(int fileSize)
Sets the file size.

Parameters: fileSize The size of the file, in bytes,

Copyright B) 2000-2009 - The Apache Software Foundation