Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve Javadoc of ServerHttpRequest#getPath

Browse Source 
Closes gh-26469
This commit is contained in:
Rossen Stoyanchev
2021-01-29 20:40:13 +00:00
parent 30cdeb23fe
commit 0ff50d6d9e
1 changed files with 9 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,5 +1,5 @@
/*
* Copyright 2002-2020 the original author or authors.
* Copyright 2002-2021 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -48,9 +48,14 @@ public interface ServerHttpRequest extends HttpRequest, ReactiveHttpInputMessage
String getId();
/**
* Returns a structured representation of the request path including the
* context path + path within application portions, path segments with
* encoded and decoded values, and path parameters.
* Returns a structured representation of the full request path up to but
* not including the {@link #getQueryParams() query}.
* <p>The returned path is sub-divided into a
* {@link RequestPath#contextPath()} portion and the remaining
* {@link RequestPath#pathWithinApplication() pathwithinApplication} portion.
* The latter can be passed into methods of
* {@link org.springframework.web.util.pattern.PathPattern} for path
* matching purposes.
*/
RequestPath getPath();