org.springframework.web.multipart

Class MultipartFileResource

java.lang.Object

org.springframework.core.io.AbstractResource

org.springframework.web.multipart.MultipartFileResource

All Implemented Interfaces:

InputStreamSource, Resource

class MultipartFileResource
extends AbstractResource

Adapt MultipartFile to Resource, exposing the content as InputStream and also overriding contentLength() as well as getFilename().

Since:

5.1

Author:

Rossen Stoyanchev

Field Summary

Fields

Modifier and Type	Field and Description
private MultipartFile	multipartFile

Constructor Summary

Constructors

Constructor and Description
MultipartFileResource(MultipartFile multipartFile)

Method Summary

Modifier and Type	Method and Description
long	contentLength() This implementation reads the entire InputStream to calculate the content length.
boolean	equals(java.lang.Object other) This implementation compares description strings.
boolean	exists() This implementation always returns true.
java.lang.String	getDescription() This implementation returns a description that has the Multipart name.
java.lang.String	getFilename() This implementation always returns null, assuming that this resource type does not have a filename.
java.io.InputStream	getInputStream() This implementation throws IllegalStateException if attempting to read the underlying stream multiple times.
int	hashCode() This implementation returns the description's hash code.
boolean	isOpen() This implementation always returns true.

Methods inherited from class org.springframework.core.io.AbstractResource

createRelative, getFile, getFileForLastModifiedCheck, getURI, getURL, isFile, isReadable, lastModified, readableChannel, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

multipartFile

private final MultipartFile multipartFile

Constructor Detail

MultipartFileResource

public MultipartFileResource(MultipartFile multipartFile)

Method Detail

exists

public boolean exists()

This implementation always returns true.

Specified by:

exists in interface Resource

Overrides:

exists in class AbstractResource

isOpen

public boolean isOpen()

This implementation always returns true.

Specified by:

isOpen in interface Resource

Overrides:

isOpen in class AbstractResource

contentLength

public long contentLength()

Description copied from class: AbstractResource

This implementation reads the entire InputStream to calculate the content length. Subclasses will almost always be able to provide a more optimal version of this, e.g. checking a File length.

Specified by:

contentLength in interface Resource

Overrides:

contentLength in class AbstractResource

See Also:

InputStreamSource.getInputStream()

getFilename

public java.lang.String getFilename()

Description copied from class: AbstractResource

This implementation always returns null, assuming that this resource type does not have a filename.

Specified by:

getFilename in interface Resource

Overrides:

getFilename in class AbstractResource

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException,
                                          java.lang.IllegalStateException

This implementation throws IllegalStateException if attempting to read the underlying stream multiple times.

Returns:

the input stream for the underlying resource (must not be null)

Throws:

java.io.FileNotFoundException - if the underlying resource doesn't exist

java.io.IOException - if the content stream could not be opened

java.lang.IllegalStateException

getDescription

public java.lang.String getDescription()

This implementation returns a description that has the Multipart name.

See Also:

Object.toString()

equals

public boolean equals(java.lang.Object other)

Description copied from class: AbstractResource

This implementation compares description strings.

Overrides:

equals in class AbstractResource

See Also:

Resource.getDescription()

hashCode

public int hashCode()

Description copied from class: AbstractResource

This implementation returns the description's hash code.

Overrides:

hashCode in class AbstractResource

See Also:

Resource.getDescription()