类 CommonsMultipartFile
- java.lang.Object
- org.springframework.web.multipart.commons.CommonsMultipartFile
- 所有已实现的接口:
Serializable
,InputStreamSource
,MultipartFile
public class CommonsMultipartFile extends Object implements MultipartFile, Serializable
MultipartFile
implementation for Apache Commons FileUpload.- 从以下版本开始:
- 29.09.2003
- 作者:
- Trevor D. Cook, Juergen Hoeller
- 另请参阅:
CommonsMultipartResolver
, 序列化表格
构造器概要
构造器 构造器 说明 CommonsMultipartFile(org.apache.commons.fileupload.FileItem fileItem)
Create an instance wrapping the given FileItem.
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 byte[]
getBytes()
Return the contents of the file as an array of bytes.String
getContentType()
Return the content type of the file.org.apache.commons.fileupload.FileItem
getFileItem()
Return the underlyingorg.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
setPreserveFilename(boolean preserveFilename)
Set whether to preserve the filename as sent by the client, not stripping off path information ingetOriginalFilename()
.void
transferTo(File dest)
Transfer the received file to the given destination file.
构造器详细资料
CommonsMultipartFile
public CommonsMultipartFile(org.apache.commons.fileupload.FileItem fileItem)
Create an instance wrapping the given FileItem.- 参数:
fileItem
- the FileItem to wrap
方法详细资料
getFileItem
public final org.apache.commons.fileupload.FileItem getFileItem()
Return the underlyingorg.apache.commons.fileupload.FileItem
instance. There is hardly any need to access this.
setPreserveFilename
public void setPreserveFilename(boolean preserveFilename)
Set whether to preserve the filename as sent by the client, not stripping off path information ingetOriginalFilename()
.Default is "false", stripping off path information that may prefix the actual filename e.g. from Opera. Switch this to "true" for preserving the client-specified filename as-is, including potential path separators.
- 从以下版本开始:
- 4.3.5
- 另请参阅:
getOriginalFilename()
,CommonsFileUploadSupport.setPreserveFilename(boolean)
getName
public String getName()
从接口复制的说明:MultipartFile
Return the name of the parameter in the multipart form.- 指定者:
getName
在接口中MultipartFile
- 返回:
- the name of the parameter (never
null
or empty)
getOriginalFilename
public String getOriginalFilename()
从接口复制的说明:MultipartFile
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.
- 指定者:
getOriginalFilename
在接口中MultipartFile
- 返回:
- the original filename, or the empty String if no file has been chosen in the multipart form, or
null
if not defined or not available - 另请参阅:
FileItem.getName()
,setPreserveFilename(boolean)
getContentType
public String getContentType()
从接口复制的说明:MultipartFile
Return the content type of the file.- 指定者:
getContentType
在接口中MultipartFile
- 返回:
- the content type, or
null
if not defined (or no file has been chosen in the multipart form)
isEmpty
public boolean isEmpty()
从接口复制的说明:MultipartFile
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.- 指定者:
isEmpty
在接口中MultipartFile
getSize
public long getSize()
从接口复制的说明:MultipartFile
Return the size of the file in bytes.- 指定者:
getSize
在接口中MultipartFile
- 返回:
- the size of the file, or 0 if empty
getBytes
public byte[] getBytes()
从接口复制的说明:MultipartFile
Return the contents of the file as an array of bytes.- 指定者:
getBytes
在接口中MultipartFile
- 返回:
- the contents of the file as bytes, or an empty byte array if empty
getInputStream
public InputStream getInputStream() throws IOException
从接口复制的说明:MultipartFile
Return an InputStream to read the contents of the file from.The user is responsible for closing the returned stream.
- 指定者:
getInputStream
在接口中InputStreamSource
- 指定者:
getInputStream
在接口中MultipartFile
- 返回:
- the contents of the file as stream, or an empty stream if empty
- 抛出:
IOException
- in case of access errors (if the temporary store fails)
transferTo
public void transferTo(File dest) throws IOException, IllegalStateException
从接口复制的说明:MultipartFile
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 target file has been moved in the filesystem, this operation cannot be invoked again afterwards. Therefore, call this method just once in order to work with any storage mechanism.
NOTE: Depending on the underlying provider, temporary storage may be container-dependent, including the base directory for relative destinations specified here (e.g. with Servlet 3.0 multipart handling). For absolute destinations, the target file may get renamed/moved from its temporary location or newly copied, even if a temporary copy already exists.
- 指定者:
transferTo
在接口中MultipartFile
- 参数:
dest
- the destination file (typically absolute)- 抛出:
IOException
- in case of reading or writing errorsIllegalStateException
- if the file has already been moved in the filesystem and is not available anymore for another transfer- 另请参阅:
FileItem.write(File)
,Part.write(String)
isAvailable
protected boolean isAvailable()
Determine whether the multipart content is still available. If a temporary file has been moved, the content is no longer available.
getStorageDescription
public String getStorageDescription()
Return a description for the storage location of the multipart content. Tries to be as specific as possible: mentions the file location in case of a temporary file.