From a63cf0649667156f0d5c889bad03298f863a1d43 Mon Sep 17 00:00:00 2001 From: rstoyanchev Date: Tue, 15 Oct 2024 19:22:49 +0100 Subject: [PATCH] Update Javadoc snippets for static resource locations Switch to FileUrlResource, the same as what is used get with the "file:" prefix in webmvc and webflux config. See gh-33712 --- .../modules/ROOT/pages/web/webflux-functional.adoc | 4 ++-- .../modules/ROOT/pages/web/webmvc-functional.adoc | 4 ++-- .../web/reactive/function/server/RouterFunctions.java | 10 +++++----- .../web/servlet/function/RouterFunctions.java | 10 +++++----- 4 files changed, 14 insertions(+), 14 deletions(-) diff --git a/framework-docs/modules/ROOT/pages/web/webflux-functional.adoc b/framework-docs/modules/ROOT/pages/web/webflux-functional.adoc index e7b2f1de212..1093c0c160f 100644 --- a/framework-docs/modules/ROOT/pages/web/webflux-functional.adoc +++ b/framework-docs/modules/ROOT/pages/web/webflux-functional.adoc @@ -835,7 +835,7 @@ Java:: + [source,java,indent=0,subs="verbatim,quotes"] ---- - Resource location = new FileSystemResource("public-resources/"); + Resource location = new FileUrlResource("public-resources/"); RouterFunction resources = RouterFunctions.resources("/resources/**", location); ---- @@ -843,7 +843,7 @@ Kotlin:: + [source,kotlin,indent=0,subs="verbatim,quotes"] ---- - val location = FileSystemResource("public-resources/") + val location = FileUrlResource("public-resources/") val resources = router { resources("/resources/**", location) } ---- ====== diff --git a/framework-docs/modules/ROOT/pages/web/webmvc-functional.adoc b/framework-docs/modules/ROOT/pages/web/webmvc-functional.adoc index 26b312a9b68..6ed6f53b0c5 100644 --- a/framework-docs/modules/ROOT/pages/web/webmvc-functional.adoc +++ b/framework-docs/modules/ROOT/pages/web/webmvc-functional.adoc @@ -813,7 +813,7 @@ Java:: + [source,java,indent=0,subs="verbatim,quotes"] ---- - Resource location = new FileSystemResource("public-resources/"); + Resource location = new FileUrlResource("public-resources/"); RouterFunction resources = RouterFunctions.resources("/resources/**", location); ---- @@ -821,7 +821,7 @@ Kotlin:: + [source,kotlin,indent=0,subs="verbatim,quotes"] ---- - val location = FileSystemResource("public-resources/") + val location = FileUrlResource("public-resources/") val resources = router { resources("/resources/**", location) } ---- ====== diff --git a/spring-webflux/src/main/java/org/springframework/web/reactive/function/server/RouterFunctions.java b/spring-webflux/src/main/java/org/springframework/web/reactive/function/server/RouterFunctions.java index 661d1e8e660..d2b81a2278e 100644 --- a/spring-webflux/src/main/java/org/springframework/web/reactive/function/server/RouterFunctions.java +++ b/spring-webflux/src/main/java/org/springframework/web/reactive/function/server/RouterFunctions.java @@ -184,7 +184,7 @@ public abstract class RouterFunctions { * Route requests that match the given pattern to resources relative to the given root location. * For instance *
-	 * Resource location = new FileSystemResource("public-resources/");
+	 * Resource location = new FileUrlResource("public-resources/");
 	 * RouterFunction<ServerResponse> resources = RouterFunctions.resources("/resources/**", location);
      * 
* @param pattern the pattern to match @@ -201,7 +201,7 @@ public abstract class RouterFunctions { * Route requests that match the given pattern to resources relative to the given root location. * For instance *
-	 * Resource location = new FileSystemResource("public-resources/");
+	 * Resource location = new FileUrlResource("public-resources/");
 	 * RouterFunction<ServerResponse> resources = RouterFunctions.resources("/resources/**", location);
      * 
* @param pattern the pattern to match @@ -224,7 +224,7 @@ public abstract class RouterFunctions { *
 	 * Mono<Resource> defaultResource = Mono.just(new ClassPathResource("index.html"));
 	 * Function<ServerRequest, Mono<Resource>> lookupFunction =
-	 *   RouterFunctions.resourceLookupFunction("/resources/**", new FileSystemResource("public-resources/"))
+	 *   RouterFunctions.resourceLookupFunction("/resources/**", new FileUrlResource("public-resources/"))
 	 *     .andThen(resourceMono -> resourceMono.switchIfEmpty(defaultResource));
 	 * RouterFunction<ServerResponse> resources = RouterFunctions.resources(lookupFunction);
      * 
@@ -761,7 +761,7 @@ public abstract class RouterFunctions { * Route requests that match the given pattern to resources relative to the given root location. * For instance *
-		 * Resource location = new FileSystemResource("public-resources/");
+		 * Resource location = new FileUrlResource("public-resources/");
 		 * RouterFunction<ServerResponse> resources = RouterFunctions.resources("/resources/**", location);
 	     * 
* @param pattern the pattern to match @@ -775,7 +775,7 @@ public abstract class RouterFunctions { * Route requests that match the given pattern to resources relative to the given root location. * For instance *
-		 * Resource location = new FileSystemResource("public-resources/");
+		 * Resource location = new FileUrlResource("public-resources/");
 		 * RouterFunction<ServerResponse> resources = RouterFunctions.resources("/resources/**", location);
 	     * 
* @param pattern the pattern to match diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/function/RouterFunctions.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/function/RouterFunctions.java index db0c724f7b5..536f3b43d01 100644 --- a/spring-webmvc/src/main/java/org/springframework/web/servlet/function/RouterFunctions.java +++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/function/RouterFunctions.java @@ -168,7 +168,7 @@ public abstract class RouterFunctions { * Route requests that match the given pattern to resources relative to the given root location. * For instance *
-	 * Resource location = new FileSystemResource("public-resources/");
+	 * Resource location = new FileUrlResource("public-resources/");
 	 * RouterFunction<ServerResponse> resources = RouterFunctions.resources("/resources/**", location);
      * 
* @param pattern the pattern to match @@ -185,7 +185,7 @@ public abstract class RouterFunctions { * Route requests that match the given pattern to resources relative to the given root location. * For instance *
-	 * Resource location = new FileSystemResource("public-resources/");
+	 * Resource location = new FileUrlResource("public-resources/");
 	 * RouterFunction<ServerResponse> resources = RouterFunctions.resources("/resources/**", location);
      * 
* @param pattern the pattern to match @@ -209,7 +209,7 @@ public abstract class RouterFunctions { *
 	 * Optional<Resource> defaultResource = Optional.of(new ClassPathResource("index.html"));
 	 * Function<ServerRequest, Optional<Resource>> lookupFunction =
-	 *   RouterFunctions.resourceLookupFunction("/resources/**", new FileSystemResource("public-resources/"))
+	 *   RouterFunctions.resourceLookupFunction("/resources/**", new FileUrlResource("public-resources/"))
 	 *     .andThen(resource -> resource.or(() -> defaultResource));
 	 * RouterFunction<ServerResponse> resources = RouterFunctions.resources(lookupFunction);
      * 
@@ -674,7 +674,7 @@ public abstract class RouterFunctions { * Route requests that match the given pattern to resources relative to the given root location. * For instance *
-		 * Resource location = new FileSystemResource("public-resources/");
+		 * Resource location = new FileUrlResource("public-resources/");
 		 * RouterFunction<ServerResponse> resources = RouterFunctions.resources("/resources/**", location);
 	     * 
* @param pattern the pattern to match @@ -688,7 +688,7 @@ public abstract class RouterFunctions { * Route requests that match the given pattern to resources relative to the given root location. * For instance *
-		 * Resource location = new FileSystemResource("public-resources/");
+		 * Resource location = new FileUrlResource("public-resources/");
 		 * RouterFunction<ServerResponse> resources = RouterFunctions.resources("/resources/**", location);
 	     * 
* @param pattern the pattern to match