|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.web.multipart.commons.CommonsMultipartFile
public class CommonsMultipartFile
MultipartFile implementation for Jakarta Commons FileUpload.
NOTE: As of Spring 2.0, this class requires Commons FileUpload 1.1 or higher. The implementation does not use any deprecated FileUpload 1.0 API anymore, to be compatible with future Commons FileUpload releases.
CommonsMultipartResolver
,
Serialized FormField Summary | |
---|---|
protected static Log |
logger
|
Constructor Summary | |
---|---|
CommonsMultipartFile(FileItem fileItem)
Create an instance wrapping the given FileItem. |
Method Summary | |
---|---|
byte[] |
getBytes()
Return the contents of the file as an array of bytes. |
String |
getContentType()
Return the content type of the file. |
FileItem |
getFileItem()
Return the underlying org.apache.commons.fileupload.FileItem
instance. |
InputStream |
getInputStream()
Return an InputStream to read the contents of the file from. |
String |
getName()
Return the name of the parameter in the multipart form. |
String |
getOriginalFilename()
Return the original filename in the client's filesystem. |
long |
getSize()
Return the size of the file in bytes. |
String |
getStorageDescription()
Return a description for the storage location of the multipart content. |
protected boolean |
isAvailable()
Determine whether the multipart content is still available. |
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(File dest)
Transfer the received file to the given destination file. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static final Log logger
Constructor Detail |
---|
public CommonsMultipartFile(FileItem fileItem)
fileItem
- the FileItem to wrapMethod Detail |
---|
public final FileItem getFileItem()
org.apache.commons.fileupload.FileItem
instance. There is hardly any need to access this.
public String getName()
MultipartFile
getName
in interface MultipartFile
null
or empty)public String getOriginalFilename()
MultipartFile
This may contain path information depending on the browser used, but it typically will not with any other than Opera.
getOriginalFilename
in interface MultipartFile
public String getContentType()
MultipartFile
getContentType
in interface MultipartFile
null
if not defined
(or no file has been chosen in the multipart form)public boolean isEmpty()
MultipartFile
isEmpty
in interface MultipartFile
public long getSize()
MultipartFile
getSize
in interface MultipartFile
public byte[] getBytes()
MultipartFile
getBytes
in interface MultipartFile
public InputStream getInputStream() throws IOException
MultipartFile
getInputStream
in interface MultipartFile
IOException
- in case of access errors (if the temporary store fails)public void transferTo(File dest) throws IOException, IllegalStateException
MultipartFile
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.
transferTo
in interface MultipartFile
dest
- the destination file
IOException
- in case of reading or writing errors
IllegalStateException
- if the file has already been moved
in the filesystem and is not available anymore for another transferprotected boolean isAvailable()
public String getStorageDescription()
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |