Package org.springframework.core.io
Class InputStreamResource
java.lang.Object
org.springframework.core.io.AbstractResource
org.springframework.core.io.InputStreamResource
- All Implemented Interfaces:
InputStreamSource
,Resource
Resource
implementation for a given InputStream
.
Should only be used if no other specific Resource
implementation
is applicable. In particular, prefer ByteArrayResource
or any of the
file-based Resource
implementations where possible.
In contrast to other Resource
implementations, this is a descriptor
for an already opened resource - therefore returning true
from
isOpen()
. Do not use an InputStreamResource
if you need to
keep the resource descriptor somewhere, or if you need to read from a stream
multiple times.
- Since:
- 28.12.2003
- Author:
- Juergen Hoeller, Sam Brannen
- See Also:
-
Constructor Summary
ConstructorDescriptionInputStreamResource
(InputStream inputStream) Create a new InputStreamResource.InputStreamResource
(InputStream inputStream, String description) Create a new InputStreamResource. -
Method Summary
Modifier and TypeMethodDescriptionboolean
This implementation compares the underlying InputStream.boolean
exists()
This implementation always returnstrue
.This implementation returns a description that includes the passed-in description, if any.This implementation throws IllegalStateException if attempting to read the underlying stream multiple times.int
hashCode()
This implementation returns the hash code of the underlying InputStream.boolean
isOpen()
This implementation always returnstrue
.Methods inherited from class org.springframework.core.io.AbstractResource
contentLength, createRelative, getFile, getFileForLastModifiedCheck, getFilename, getURI, getURL, isFile, isReadable, lastModified, readableChannel, toString
-
Constructor Details
-
InputStreamResource
Create a new InputStreamResource.- Parameters:
inputStream
- the InputStream to use
-
InputStreamResource
Create a new InputStreamResource.- Parameters:
inputStream
- the InputStream to usedescription
- where the InputStream comes from
-
-
Method Details
-
exists
public boolean exists()This implementation always returnstrue
.- Specified by:
exists
in interfaceResource
- Overrides:
exists
in classAbstractResource
-
isOpen
public boolean isOpen()This implementation always returnstrue
.- Specified by:
isOpen
in interfaceResource
- Overrides:
isOpen
in classAbstractResource
-
getInputStream
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:
FileNotFoundException
- if the underlying resource does not existIOException
- if the content stream could not be openedIllegalStateException
- See Also:
-
getDescription
This implementation returns a description that includes the passed-in description, if any.- See Also:
-
equals
This implementation compares the underlying InputStream.- Overrides:
equals
in classAbstractResource
- See Also:
-
hashCode
public int hashCode()This implementation returns the hash code of the underlying InputStream.- Overrides:
hashCode
in classAbstractResource
- See Also:
-