com.yanzhenjie.andserver.http.multipart

Class StandardMultipartFile

java.lang.Object

com.yanzhenjie.andserver.http.multipart.StandardMultipartFile

All Implemented Interfaces:

MultipartFile, java.io.Serializable

public class StandardMultipartFile
extends java.lang.Object
implements MultipartFile, java.io.Serializable

Created by Zhenjie Yan on 2018/6/21.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StandardMultipartFile(FileItem fileItem) Create an instance wrapping the given FileItem.

Method Summary

Modifier and Type	Method and Description
byte[]	getBytes() Return the contents of the file as an array of bytes.
MediaType	getContentType() Return the content type of the file.
FileItem	getFileItem() Return the underlying FileItem instance.
java.lang.String	getFilename() Return the original filename in the client's filesystem.
java.lang.String	getName() Return the name of the parameter in the multipart form.
long	getSize() Return the size of the file in bytes.
java.io.InputStream	getStream() Return an InputStream to read the contents of the file from.
protected boolean	isAvailable() Determine whether the multipart content is still available.
boolean	isEmpty() Return whether the uploaded file is empty.
void	transferTo(java.io.File dest) Writing 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

Constructor Detail

StandardMultipartFile

public StandardMultipartFile(FileItem fileItem)

Create an instance wrapping the given FileItem.

Parameters:

fileItem - the FileItem to wrap.

Method Detail

getFileItem

public final FileItem getFileItem()

Return the underlying FileItem instance. There is hardly any need to access this.

getName

public java.lang.String getName()

Description copied from interface: MultipartFile

Return the name of the parameter in the multipart form.

Specified by:

getName in interface MultipartFile

Returns:

the name of the parameter.

getFilename

public java.lang.String getFilename()

Description copied from interface: MultipartFile

Return the original filename in the client's filesystem.

Specified by:

getFilename in interface MultipartFile

Returns:

the original filename, or the empty String if no file, or null if not defined.

See Also:

FileItem#getName()

getContentType

public MediaType getContentType()

Description copied from interface: MultipartFile

Return the content type of the file.

Specified by:

getContentType in interface MultipartFile

Returns:

the content type, or the empty String if no file, or null if not defined.

isEmpty

public boolean isEmpty()

Description copied from interface: MultipartFile

Return whether the uploaded file is empty.

Specified by:

isEmpty in interface MultipartFile

Returns:

true, otherwise is false.

getSize

public long getSize()

Description copied from interface: MultipartFile

Return the size of the file in bytes.

Specified by:

getSize in interface MultipartFile

Returns:

the size of the file, or 0 if empty.

getBytes

public byte[] getBytes()

Description copied from interface: MultipartFile

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

Specified by:

getBytes in interface MultipartFile

Returns:

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

getStream

public java.io.InputStream getStream()
                              throws java.io.IOException

Description copied from interface: MultipartFile

Return an InputStream to read the contents of the file from.

Specified by:

getStream in interface MultipartFile

Returns:

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

Throws:

java.io.IOException - in case of access errors.

transferTo

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

Description copied from interface: MultipartFile

Writing the received file to the given destination file. If the destination file already exists, it will be deleted first.

If the target file has been written to disk, this operation cannot be invoked again afterwards.

Specified by:

transferTo in interface MultipartFile

Parameters:

dest - the destination file.

Throws:

java.io.IOException

java.lang.IllegalStateException

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.