Class AbstractResource
java.lang.Object
nl.basjes.parse.useragent.utils.springframework.core.io.AbstractResource
- All Implemented Interfaces:
InputStreamSource
,Resource
- Direct Known Subclasses:
AbstractFileResolvingResource
,FileSystemResource
,VfsResource
Convenience base class for {link Resource} implementations,
pre-implementing typical behavior.
The "exists" method will check whether a File or InputStream can be opened; "isOpen" will always return false; "getURL" and "getFile" throw an exception; and "toString" will return the description.
- Since:
- 28.12.2003
- Author:
- Juergen Hoeller, Sam Brannen
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionlong
This method reads the entire InputStream to determine the content length.createRelative
(String relativePath) This implementation throws a FileNotFoundException, assuming that relative resources cannot be created for this resource.boolean
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.getFile()
This implementation throws a FileNotFoundException, assuming that the resource cannot be resolved to an absolute file path.This implementation always returnsnull
, assuming that this resource type does not have a filename.getURI()
This implementation builds a URI based on the URL returned by {link #getURL()}.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
isFile()
This implementation always returnsfalse
.boolean
isOpen()
This implementation always returnsfalse
.toString()
This implementation returns the description of this resource.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface nl.basjes.parse.useragent.utils.springframework.core.io.InputStreamSource
getInputStream
Methods inherited from interface nl.basjes.parse.useragent.utils.springframework.core.io.Resource
getDescription
-
Constructor Details
-
AbstractResource
public AbstractResource()
-
-
Method Details
-
exists
public boolean exists()This 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.
-
isOpen
public boolean isOpen()This implementation always returnsfalse
. -
isFile
public boolean isFile()This implementation always returnsfalse
. -
getURL
This implementation throws a FileNotFoundException, assuming that the resource cannot be resolved to a URL.- Specified by:
getURL
in interfaceResource
- Throws:
IOException
- if the resource cannot be resolved as URL, i.e. if the resource is not available as a descriptor
-
getURI
This implementation builds a URI based on the URL returned by {link #getURL()}.- Specified by:
getURI
in interfaceResource
- Throws:
IOException
- if the resource cannot be resolved as URI, i.e. if the resource is not available as a descriptor
-
getFile
This implementation throws a FileNotFoundException, assuming that the resource cannot be resolved to an absolute file path.- Specified by:
getFile
in interfaceResource
- Throws:
FileNotFoundException
- if the resource cannot be resolved as absolute file path, i.e. if the resource is not available in a file systemIOException
- in case of general resolution/reading failures see #getInputStream()
-
contentLength
This method reads the entire InputStream to determine the content length.For a custom subclass of
InputStreamResource
, we strongly recommend overriding this method with a more optimal implementation, e.g. checking File length, or possibly simply returning -1 if the stream can only be read once. see #getInputStream()- Specified by:
contentLength
in interfaceResource
- Throws:
IOException
- if the resource cannot be resolved (in the file system or as some other known physical resource type)
-
createRelative
This implementation throws a FileNotFoundException, assuming that relative resources cannot be created for this resource.- Specified by:
createRelative
in interfaceResource
- Parameters:
relativePath
- the relative path (relative to this resource)- Returns:
- the resource handle for the relative resource
- Throws:
IOException
- if the relative resource cannot be determined
-
getFilename
This implementation always returnsnull
, assuming that this resource type does not have a filename.- Specified by:
getFilename
in interfaceResource
-
equals
This implementation compares description strings. see #getDescription() -
hashCode
public int hashCode()This implementation returns the description's hash code. see #getDescription() -
toString
This implementation returns the description of this resource. see #getDescription()
-