public class

MockMultipartFile

extends Object
implements MultipartFile
java.lang.Object
   ↳ org.springframework.mock.web.MockMultipartFile

Class Overview

Mock implementation of the MultipartFile interface.

Useful in conjunction with a MockMultipartHttpServletRequest for testing application controllers that access multipart uploads.

See Also

Summary

Public Constructors
MockMultipartFile(String name, byte[] content)
Create a new MockMultipartFile with the given content.
MockMultipartFile(String name, InputStream contentStream)
Create a new MockMultipartFile with the given content.
MockMultipartFile(String name, String originalFilename, String contentType, byte[] content)
Create a new MockMultipartFile with the given content.
MockMultipartFile(String name, String originalFilename, String contentType, InputStream contentStream)
Create a new MockMultipartFile with the given content.
Public Methods
byte[] getBytes()
Return the contents of the file as an array of bytes.
String getContentType()
Return the content type of the file.
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.
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.
[Expand]
Inherited Methods
From class java.lang.Object
From interface org.springframework.web.multipart.MultipartFile

Public Constructors

public MockMultipartFile (String name, byte[] content)

Create a new MockMultipartFile with the given content.

Parameters
name the name of the file
content the content of the file

public MockMultipartFile (String name, InputStream contentStream)

Create a new MockMultipartFile with the given content.

Parameters
name the name of the file
contentStream the content of the file as stream
Throws
IOException if reading from the stream failed

public MockMultipartFile (String name, String originalFilename, String contentType, byte[] content)

Create a new MockMultipartFile with the given content.

Parameters
name the name of the file
originalFilename the original filename (as on the client's machine)
contentType the content type (if known)
content the content of the file

public MockMultipartFile (String name, String originalFilename, String contentType, InputStream contentStream)

Create a new MockMultipartFile with the given content.

Parameters
name the name of the file
originalFilename the original filename (as on the client's machine)
contentType the content type (if known)
contentStream the content of the file as stream
Throws
IOException if reading from the stream failed

Public Methods

public byte[] getBytes ()

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
IOException

public String getContentType ()

Return the content type of the file.

Returns
  • the content type, or null if not defined (or no file has been chosen in the multipart form)

public InputStream getInputStream ()

Return an InputStream to read the contents of the file from. The user is responsible for closing the stream.

Returns
  • the contents of the file as stream, or an empty stream if empty
Throws
IOException

public String getName ()

Return the name of the parameter in the multipart form.

Returns
  • the name of the parameter (never null or empty)

public String getOriginalFilename ()

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.

Returns
  • the original filename, or the empty String if no file has been chosen in the multipart form

public long getSize ()

Return the size of the file in bytes.

Returns
  • the size of the file, or 0 if empty

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

public void transferTo (File dest)

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

Parameters
dest the destination file
Throws
IOException
IllegalStateException