Skip to content

Commit 0ff50d6

Browse files
committed
Improve Javadoc of ServerHttpRequest#getPath
Closes gh-26469
1 parent 30cdeb2 commit 0ff50d6

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

spring-web/src/main/java/org/springframework/http/server/reactive/ServerHttpRequest.java

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2020 the original author or authors.
2+
* Copyright 2002-2021 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -48,9 +48,14 @@ public interface ServerHttpRequest extends HttpRequest, ReactiveHttpInputMessage
4848
String getId();
4949

5050
/**
51-
* Returns a structured representation of the request path including the
52-
* context path + path within application portions, path segments with
53-
* encoded and decoded values, and path parameters.
51+
* Returns a structured representation of the full request path up to but
52+
* not including the {@link #getQueryParams() query}.
53+
* <p>The returned path is sub-divided into a
54+
* {@link RequestPath#contextPath()} portion and the remaining
55+
* {@link RequestPath#pathWithinApplication() pathwithinApplication} portion.
56+
* The latter can be passed into methods of
57+
* {@link org.springframework.web.util.pattern.PathPattern} for path
58+
* matching purposes.
5459
*/
5560
RequestPath getPath();
5661

0 commit comments

Comments
 (0)