com.yanzhenjie.andserver.http.multipart

Interface MultipartFile

All Known Implementing Classes:

StandardMultipartFile

public interface MultipartFile

Created by Zhenjie Yan on 2018/6/18.

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.
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.
boolean	isEmpty() Return whether the uploaded file is empty.
void	transferTo(java.io.File dest) Writing the received file to the given destination file.

Method Detail

getName

java.lang.String getName()

Return the name of the parameter in the multipart form.

Returns:

the name of the parameter.

getFilename

java.lang.String getFilename()

Return the original filename in the client's filesystem.

Returns:

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

See Also:

FileItem#getName()

getContentType

MediaType getContentType()

Return the content type of the file.

Returns:

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

isEmpty

boolean isEmpty()

Return whether the uploaded file is empty.

Returns:

true, otherwise is false.

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).

getStream

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

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

Returns:

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

Throws:

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

transferTo

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

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.

Parameters:

dest - the destination file.

Throws:

java.io.IOException

java.lang.IllegalStateException