public interface Resource
| Modifier and Type | Method and Description |
|---|---|
boolean |
exists()
Returns true if the resource exists; if a stream to the content of the file may be opened.
|
Resource |
forFile(String relativePath)
Returns a Resource based on a relative path, relative to the folder containing the resource.
|
Resource |
forLocale(Locale locale)
Returns a localized version of the resource.
|
String |
getFile()
Returns the file portion of the Resource path, everything that follows the final forward slash.
|
String |
getFolder()
Returns the portion of the path up to the last forward slash; this is the directory or folder portion of the
Resource.
|
String |
getPath()
Return the path (the combination of folder and file).
|
boolean |
isVirtual()
Returns true if the resource is virtual, meaning this is no underlying file.
|
InputStream |
openStream()
Opens a stream to the content of the resource, or returns null if the resource does not exist.
|
URL |
toURL()
Returns the URL for the resource, or null if it does not exist.
|
Resource |
withExtension(String extension)
Returns a new Resource with the extension changed (or, if the resource does not have an extension, the extension
is added).
|
boolean exists()
toURL() returns a non-null value. Starting in release 5.3.4, the result of this is cached.
Starting in 5.4, some "virtual resources", may return true even though toURL() returns null.boolean isVirtual()
toURL(), forLocale(java.util.Locale),
withExtension(String), getFile(), getFolder(), getPath()}; these
operations will throw an UnsupportedOperationException.InputStream openStream() throws IOException
BufferedInputStream.IOExceptionURL toURL()
Resource forLocale(Locale locale)
Resource forFile(String relativePath)
Resource withExtension(String extension)
toURL() may return null.extension - to apply to the resource, such as "html" or "properties"String getFolder()
String getFile()
5.6.4 - Copyright © 2003-2021 The Apache Software Foundation.