Class Overview
Resource
implementation for a given InputStream. Should only
be used if no 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 it if you need to keep the resource
descriptor somewhere, or if you need to read a stream multiple times.
Summary
Public Methods |
boolean
|
equals(Object obj)
This implementation compares the underlying InputStream.
|
boolean
|
exists()
This implementation always returns true .
|
String
|
getDescription()
This implementation returns the passed-in description, if any.
|
InputStream
|
getInputStream()
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 returns true .
|
[Expand]
Inherited Methods |
From class
org.springframework.core.io.AbstractResource
long
|
contentLength()
This implementation checks the timestamp of the underlying File,
if available.
|
Resource
|
createRelative(String relativePath)
This implementation throws a FileNotFoundException, assuming
that relative resources cannot be created for this resource.
|
boolean
|
equals(Object obj)
This implementation compares description strings.
|
boolean
|
exists()
This implementation checks whether a File can be opened,
falling back to whether an InputStream can be opened.
|
File
|
getFile()
This implementation throws a FileNotFoundException, assuming
that the resource cannot be resolved to an absolute file path.
|
File
|
getFileForLastModifiedCheck()
Determine the File to use for timestamp checking.
|
String
|
getFilename()
This implementation always throws IllegalStateException,
assuming that the resource does not have a filename.
|
URI
|
getURI()
This implementation builds a URI based on the URL returned
by getURL() .
|
URL
|
getURL()
This implementation throws a FileNotFoundException, assuming
that the resource cannot be resolved to a URL.
|
int
|
hashCode()
This implementation returns the description's hash code.
|
boolean
|
isOpen()
This implementation always returns false .
|
boolean
|
isReadable()
This implementation always returns true .
|
long
|
lastModified()
This implementation checks the timestamp of the underlying File,
if available.
|
String
|
toString()
This implementation returns the description of this resource.
|
|
From class
java.lang.Object
Object
|
clone()
|
boolean
|
equals(Object arg0)
|
void
|
finalize()
|
final
Class<?>
|
getClass()
|
int
|
hashCode()
|
final
void
|
notify()
|
final
void
|
notifyAll()
|
String
|
toString()
|
final
void
|
wait()
|
final
void
|
wait(long arg0, int arg1)
|
final
void
|
wait(long arg0)
|
|
From interface
org.springframework.core.io.InputStreamSource
|
From interface
org.springframework.core.io.Resource
abstract
long
|
contentLength()
Determine the content length for this resource.
|
abstract
Resource
|
createRelative(String relativePath)
Create a resource relative to this resource.
|
abstract
boolean
|
exists()
Return whether this resource actually exists in physical form.
|
abstract
String
|
getDescription()
Return a description for this resource,
to be used for error output when working with the resource.
|
abstract
File
|
getFile()
Return a File handle for this resource.
|
abstract
String
|
getFilename()
Return a filename for this resource, i.e.
|
abstract
URI
|
getURI()
Return a URI handle for this resource.
|
abstract
URL
|
getURL()
Return a URL handle for this resource.
|
abstract
boolean
|
isOpen()
Return whether this resource represents a handle with an open
stream.
|
abstract
boolean
|
isReadable()
Return whether the contents of this resource can be read,
e.g.
|
abstract
long
|
lastModified()
Determine the last-modified timestamp for this resource.
|
|
Public Constructors
public
InputStreamResource
(InputStream inputStream)
Create a new InputStreamResource.
Parameters
inputStream
| the InputStream to use
|
public
InputStreamResource
(InputStream inputStream, String description)
Create a new InputStreamResource.
Parameters
inputStream
| the InputStream to use |
description
| where the InputStream comes from
|
Public Methods
public
boolean
equals
(Object obj)
This implementation compares the underlying InputStream.
public
boolean
exists
()
This implementation always returns true
.
public
String
getDescription
()
This implementation returns the passed-in description, if any.
public
InputStream
getInputStream
()
This implementation throws IllegalStateException if attempting to
read the underlying stream multiple times.
public
int
hashCode
()
This implementation returns the hash code of the underlying InputStream.
public
boolean
isOpen
()
This implementation always returns true
.