Cwikius-Spring/spring-security
1
0
Fork 0
mirror of https://github.com/spring-projects/spring-security.git synced 2025-05-31 09:12:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Polish javadoc

Browse Source 
Signed-off-by: Tran Ngoc Nhan <ngocnhan.tran1996@gmail.com>
This commit is contained in:
Tran Ngoc Nhan 2025-04-11 23:05:03 +07:00 committed by Josh Cummings
parent 8525f0e3fd
commit 29380a87a0
2 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
web/src/main/java/org/springframework/security/web/servlet/util/matcher/PathPatternRequestMatcher.java
View File

@ -172,7 +172,9 @@ public final class PathPatternRequestMatcher implements RequestMatcher {
*
* <p>
* If you have many paths that have a common path prefix, you can use
* {@link #basePath} to reduce repetition like so: <code>
* {@link #basePath} to reduce repetition like so:
*
* <pre>
* PathPatternRequestMatcher.Builder mvc = withDefaults().basePath("/mvc");
* http
* .authorizeHttpRequests((authorize) -> authorize
@ -180,7 +182,7 @@ public final class PathPatternRequestMatcher implements RequestMatcher {
* .requestMatchers(mvc.matcher("/admin/**")).hasAuthority("admin")
* )
* ...
* </code>
* </pre>
*/
public static final class Builder {

14
web/src/main/java/org/springframework/security/web/util/matcher/RequestMatcher.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2002-2019 the original author or authors.
* Copyright 2002-2025 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.
@ -38,7 +38,7 @@ public interface RequestMatcher {
boolean matches(HttpServletRequest request);
/**
* Returns a MatchResult for this RequestMatcher The default implementation returns
* Returns a MatchResult for this RequestMatcher. The default implementation returns
* {@link Collections#emptyMap()} when {@link MatchResult#getVariables()} is invoked.
* @return the MatchResult from comparing this RequestMatcher against the
* HttpServletRequest
@ -50,7 +50,7 @@ public interface RequestMatcher {
}
/**
* The result of matching against an HttpServletRequest Contains the status, true or
* The result of matching against an HttpServletRequest contains the status, true or
* false, of the match and if present, any variables extracted from the match
*
* @since 5.2
@ -86,7 +86,7 @@ public interface RequestMatcher {
/**
* Creates an instance of {@link MatchResult} that is a match with no variables
* @return
* @return {@link MatchResult} that is a match with no variables
*/
public static MatchResult match() {
return new MatchResult(true, Collections.emptyMap());
@ -95,8 +95,8 @@ public interface RequestMatcher {
/**
* Creates an instance of {@link MatchResult} that is a match with the specified
* variables
* @param variables
* @return
* @param variables the specified variables
* @return {@link MatchResult} that is a match with the specified variables
*/
public static MatchResult match(Map<String, String> variables) {
return new MatchResult(true, variables);
@ -104,7 +104,7 @@ public interface RequestMatcher {
/**
* Creates an instance of {@link MatchResult} that is not a match.
* @return
* @return {@link MatchResult} that is not a match
*/
public static MatchResult notMatch() {
return new MatchResult(false, Collections.emptyMap());