org.springframework.core.io
Class DescriptiveResource
- java.lang.Object
-
- org.springframework.core.io.AbstractResource
-
- org.springframework.core.io.DescriptiveResource
-
- All Implemented Interfaces:
- InputStreamSource, Resource
public class DescriptiveResource extends AbstractResource
SimpleResourceimplementation that holds a resource description but does not point to an actually readable resource.To be used as placeholder if a
Resourceargument is expected by an API but not necessarily used for actual reading.- Since:
- 1.2.6
- Author:
- Juergen Hoeller
-
Constructor Summary
Constructors Constructor and Description DescriptiveResource(String description)Create a new DescriptiveResource.
Method Summary
Methods Modifier and Type Method and Description booleanequals(Object obj)This implementation compares the underlying description String.booleanexists()This implementation checks whether a File can be opened, falling back to whether an InputStream can be opened.StringgetDescription()Return a description for this resource, to be used for error output when working with the resource.InputStreamgetInputStream()Return anInputStream.inthashCode()This implementation returns the hash code of the underlying description String.booleanisReadable()This implementation always returnstrue.Methods inherited from class org.springframework.core.io.AbstractResource
contentLength, createRelative, getFile, getFileForLastModifiedCheck, getFilename, getURI, getURL, isOpen, lastModified, toString
-
Constructor Detail
DescriptiveResource
public DescriptiveResource(String description)
Create a new DescriptiveResource.- Parameters:
-
description- the resource description
Method Detail
exists
public boolean exists()
Description copied from class:AbstractResourceThis implementation checks whether a File can be opened, falling back to whether an InputStream can be opened. This will cover both directories and content resources.- Specified by:
-
existsin interfaceResource - Overrides:
-
existsin classAbstractResource
isReadable
public boolean isReadable()
Description copied from class:AbstractResourceThis implementation always returnstrue.- Specified by:
-
isReadablein interfaceResource - Overrides:
-
isReadablein classAbstractResource - See Also:
-
InputStreamSource.getInputStream()
getInputStream
public InputStream getInputStream() throws IOException
Description copied from interface:InputStreamSourceReturn anInputStream.It is expected that each call creates a fresh stream.
This requirement is particularly important when you consider an API such as JavaMail, which needs to be able to read the stream multiple times when creating mail attachments. For such a use case, it is required that each
getInputStream()call returns a fresh stream.- Returns:
-
the input stream for the underlying resource (must not be
null) - Throws:
-
IOException- if the stream could not be opened - See Also:
-
org.springframework.mail.javamail.MimeMessageHelper#addAttachment(String, InputStreamSource)
getDescription
public String getDescription()
Description copied from interface:ResourceReturn a description for this resource, to be used for error output when working with the resource.Implementations are also encouraged to return this value from their
toStringmethod.- See Also:
-
Object.toString()
equals
public boolean equals(Object obj)
This implementation compares the underlying description String.- Overrides:
-
equalsin classAbstractResource - See Also:
-
Resource.getDescription()
hashCode
public int hashCode()
This implementation returns the hash code of the underlying description String.- Overrides:
-
hashCodein classAbstractResource - See Also:
-
Resource.getDescription()