From 7225238ad56254bb9b580682ddacba381e92e936 Mon Sep 17 00:00:00 2001 From: Sam Brannen Date: Mon, 15 Feb 2021 20:40:40 +0100 Subject: [PATCH] Update Resource interface in the reference manual See gh-26447 --- src/docs/asciidoc/core/core-resources.adoc | 41 +++++++++++++++++++--- 1 file changed, 36 insertions(+), 5 deletions(-) diff --git a/src/docs/asciidoc/core/core-resources.adoc b/src/docs/asciidoc/core/core-resources.adoc index 35249630b6db..30748a9607f1 100644 --- a/src/docs/asciidoc/core/core-resources.adoc +++ b/src/docs/asciidoc/core/core-resources.adoc @@ -33,9 +33,11 @@ such as a method to check for the existence of the resource being pointed to. [[resources-resource]] == The Resource Interface -Spring's `Resource` interface is meant to be a more capable interface for abstracting -access to low-level resources. The following listing shows the `Resource` interface -definition: +Spring's `Resource` interface located in the `org.springframework.core.io.` package is +meant to be a more capable interface for abstracting access to low-level resources. The +following listing provides an overview of the `Resource` interface. See the +{api-spring-framework}/core/io/Resource.html[`Resource`] javadoc for further details. + [source,java,indent=0,subs="verbatim,quotes",role="primary"] .Java @@ -44,17 +46,30 @@ definition: boolean exists(); + boolean isReadable(); + boolean isOpen(); + boolean isFile(); + URL getURL() throws IOException; + URI getURI() throws IOException; + File getFile() throws IOException; + ReadableByteChannel readableChannel() throws IOException; + + long contentLength() throws IOException; + + long lastModified() throws IOException; + Resource createRelative(String relativePath) throws IOException; String getFilename(); String getDescription(); + } ---- [source,kotlin,indent=0,subs="verbatim,quotes",role="secondary"] @@ -64,12 +79,28 @@ definition: fun exists(): Boolean - val isOpen: Boolean + fun isReadable(): Boolean + + fun isOpen(): Boolean - val url: URL + fun isFile(): Boolean + + fun getURL(): URL + + @Throws(IOException::class) + fun getURI(): URI val file: File + @Throws(IOException::class) + fun readableChannel(): ReadableByteChannel + + @Throws(IOException::class) + fun contentLength(): long + + @Throws(IOException::class) + fun lastModified(): long + @Throws(IOException::class) fun createRelative(relativePath: String): Resource