Update contribution

Closes gh-35273

Author: rstoyanchev

spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/InterceptorRegistration.java

@@ -83,8 +83,9 @@ public InterceptorRegistration addPathPatterns(String... patterns) {
 	 * @since 5.0.3
 	 */
 	public InterceptorRegistration addPathPatterns(List<String> patterns) {
-		this.includePatterns = (this.includePatterns != null ?
-				this.includePatterns : new ArrayList<>(patterns.size()));
+		if (this.includePatterns == null) {
+			this.includePatterns = new ArrayList<>(patterns.size());
+		}
 		this.includePatterns.addAll(patterns);
 		return this;
 	}
@@ -105,48 +106,50 @@ public InterceptorRegistration excludePathPatterns(String... patterns) {
 	 * @since 5.0.3
 	 */
 	public InterceptorRegistration excludePathPatterns(List<String> patterns) {
-		this.excludePatterns = (this.excludePatterns != null ?
-				this.excludePatterns : new ArrayList<>(patterns.size()));
+		if (this.excludePatterns == null) {
+			this.excludePatterns = new ArrayList<>(patterns.size());
+		}
 		this.excludePatterns.addAll(patterns);
 		return this;
 	}
 
 	/**
-	 * Add HTTP methods the interceptor should be included for.
-	 * <p>Only requests with these HTTP methods will be intercepted.
-	 * @since 7.0.x
+	 * Add HTTP methods for requests the interceptor should be included in.
+	 * @since 7.0
 	 */
 	public InterceptorRegistration includeHttpMethods(HttpMethod... httpMethods) {
 		return includeHttpMethods(Arrays.asList(httpMethods));
 	}
 
 	/**
 	 * List-based variant of {@link #includeHttpMethods(HttpMethod...)}.
-	 * @since 7.0.x
+	 * @since 7.0
 	 */
 	public InterceptorRegistration includeHttpMethods(List<HttpMethod> httpMethods) {
-		this.includeHttpMethods = (this.includeHttpMethods != null ?
-				this.includeHttpMethods : new ArrayList<>(httpMethods.size()));
+		if (this.includeHttpMethods == null) {
+			this.includeHttpMethods = new ArrayList<>(httpMethods.size());
+		}
 		this.includeHttpMethods.addAll(httpMethods);
 		return this;
 	}
 
 	/**
-	 * Add HTTP methods the interceptor should be excluded from.
+	 * Add HTTP methods for requests the interceptor should be excluded from.
 	 * <p>Requests with these HTTP methods will be ignored by the interceptor.
-	 * @since 7.0.x
+	 * @since 7.0
 	 */
-	public InterceptorRegistration excludeHttpMethods(HttpMethod... httpMethods){
-		return this.excludeHttpMethods(Arrays.asList(httpMethods));
+	public InterceptorRegistration excludeHttpMethods(HttpMethod... httpMethods) {
+		return excludeHttpMethods(Arrays.asList(httpMethods));
 	}
 
 	/**
 	 * List-based variant of {@link #excludeHttpMethods(HttpMethod...)}.
-	 * @since 7.0.x
+	 * @since 7.0
 	 */
-	public InterceptorRegistration excludeHttpMethods(List<HttpMethod> httpMethods){
-		this.excludeHttpMethods = (this.excludeHttpMethods != null ?
-				this.excludeHttpMethods : new ArrayList<>(httpMethods.size()));
+	public InterceptorRegistration excludeHttpMethods(List<HttpMethod> httpMethods) {
+		if (this.excludeHttpMethods == null) {
+			this.excludeHttpMethods = new ArrayList<>(httpMethods.size());
+		}
 		this.excludeHttpMethods.addAll(httpMethods);
 		return this;
 	}
@@ -175,7 +178,7 @@ public InterceptorRegistration pathMatcher(PathMatcher pathMatcher) {
 	 * Specify an order position to be used. Default is 0.
 	 * @since 4.3.23
 	 */
-	public InterceptorRegistration order(int order){
+	public InterceptorRegistration order(int order) {
 		this.order = order;
 		return this;
 	}
@@ -194,27 +197,18 @@ protected int getOrder() {
 	@SuppressWarnings("removal")
 	protected Object getInterceptor() {
 
-		if (this.includePatterns == null && this.excludePatterns == null && this.includeHttpMethods == null && this.excludeHttpMethods == null) {
+		if (this.includePatterns == null && this.excludePatterns == null &&
+				this.includeHttpMethods == null && this.excludeHttpMethods == null) {
+
 			return this.interceptor;
 		}
 
-		HttpMethod[] includeMethodsArray = (this.includeHttpMethods != null) ?
-				this.includeHttpMethods.toArray(new HttpMethod[0]) : null;
-
-		HttpMethod[] excludeMethodsArray = (this.excludeHttpMethods != null) ?
-				this.excludeHttpMethods.toArray(new HttpMethod[0]) : null;
-
-		String[] includePattersArray = StringUtils.toStringArray(this.includePatterns);
-
-		String[] excludePattersArray = StringUtils.toStringArray(this.excludePatterns);
-
-
 		MappedInterceptor mappedInterceptor = new MappedInterceptor(
-				includePattersArray,
-				excludePattersArray,
-				includeMethodsArray,
-				excludeMethodsArray,
-				this.interceptor);
+				StringUtils.toStringArray(this.includePatterns),
+				StringUtils.toStringArray(this.excludePatterns),
+				(this.includeHttpMethods != null) ? this.includeHttpMethods.toArray(new HttpMethod[0]) : null,
+				(this.excludeHttpMethods != null) ? this.excludeHttpMethods.toArray(new HttpMethod[0]) : null,
+				this.interceptor, null);
 
 		if (this.pathMatcher != null) {
 			mappedInterceptor.setPathMatcher(this.pathMatcher);

spring-webmvc/src/main/java/org/springframework/web/servlet/handler/MappedInterceptor.java

@@ -68,66 +68,69 @@ public final class MappedInterceptor implements HandlerInterceptor {
 
 	private final PatternAdapter @Nullable [] excludePatterns;
 
-	private final MethodAdapter @Nullable [] includeHttpMethods;
+	private final HttpMethod @Nullable [] includeHttpMethods;
 
-	private final MethodAdapter @Nullable [] excludeHttpMethods;
+	private final HttpMethod @Nullable [] excludeHttpMethods;
 
 	private PathMatcher pathMatcher = defaultPathMatcher;
 
 	private final HandlerInterceptor interceptor;
 
 
 	/**
-	 * Create an instance with the given include and exclude patterns along with
-	 * the target interceptor for the mappings.
-	 * @param includePatterns patterns to which requests must match, or null to
-	 * match all paths
-	 * @param excludePatterns patterns to which requests must not match
-	 * @param includeHttpMethods http methods to which request must match, or null to match all paths
-	 * @param excludeHttpMethods http methods to which request must not match
+	 * Create an instance with the given include and exclude patterns and HTTP methods.
+	 * @param includePatterns patterns to match, or null to match all paths
+	 * @param excludePatterns patterns for which requests must not match
+	 * @param includeHttpMethods the HTTP methods to match, or null for all methods
+	 * @param excludeHttpMethods the ßHTTP methods to which requests must not match
 	 * @param interceptor the target interceptor
 	 * @param parser a parser to use to pre-parse patterns into {@link PathPattern};
 	 * when not provided, {@link PathPatternParser#defaultInstance} is used.
-	 * @since 5.3
+	 * @since 7.0
 	 */
-	public MappedInterceptor(String @Nullable [] includePatterns, String @Nullable [] excludePatterns, HttpMethod @Nullable [] includeHttpMethods, HttpMethod @Nullable [] excludeHttpMethods,
+	public MappedInterceptor(String @Nullable [] includePatterns, String @Nullable [] excludePatterns,
+			HttpMethod @Nullable [] includeHttpMethods, HttpMethod @Nullable [] excludeHttpMethods,
 			HandlerInterceptor interceptor, @Nullable PathPatternParser parser) {
 
 		this.includePatterns = PatternAdapter.initPatterns(includePatterns, parser);
 		this.excludePatterns = PatternAdapter.initPatterns(excludePatterns, parser);
-		this.includeHttpMethods = MethodAdapter.initHttpMethods(includeHttpMethods);
-		this.excludeHttpMethods = MethodAdapter.initHttpMethods(excludeHttpMethods);
+		this.includeHttpMethods = includeHttpMethods;
+		this.excludeHttpMethods = excludeHttpMethods;
 		this.interceptor = interceptor;
 	}
 
-
 	/**
-	 * Variant of
+	 * Variation of
 	 * {@link #MappedInterceptor(String[], String[], HttpMethod[], HttpMethod[], HandlerInterceptor, PathPatternParser)}
-	 * with include patterns only.
+	 * without HTTP methods.
+	 * @since 5.3
+	 * @deprecated in favor of the constructor variant with HTTP methods
 	 */
-	public MappedInterceptor(String @Nullable [] includePatterns, HandlerInterceptor interceptor) {
-		this(includePatterns, null, null, null, interceptor);
+	@Deprecated(since = "7.0", forRemoval = true)
+	public MappedInterceptor(String @Nullable [] includePatterns, String @Nullable [] excludePatterns,
+			HandlerInterceptor interceptor, @Nullable PathPatternParser parser) {
+
+		this(includePatterns, excludePatterns, null, null, interceptor, parser);
 	}
 
 	/**
 	 * Variant of
 	 * {@link #MappedInterceptor(String[], String[], HttpMethod[], HttpMethod[], HandlerInterceptor, PathPatternParser)}
-	 * with include methods only.
+	 * with include patterns only.
 	 */
-	public MappedInterceptor(HttpMethod @Nullable [] includeHttpMethods, HandlerInterceptor interceptor) {
-		this(null, null, includeHttpMethods, null, interceptor);
+	public MappedInterceptor(String @Nullable [] includePatterns, HandlerInterceptor interceptor) {
+		this(includePatterns, null, null, null, interceptor, null);
 	}
 
 	/**
 	 * Variant of
 	 * {@link #MappedInterceptor(String[], String[], HttpMethod[], HttpMethod[], HandlerInterceptor, PathPatternParser)}
 	 * without a provided parser.
 	 */
-	public MappedInterceptor(String @Nullable [] includePatterns, String @Nullable [] excludePatterns, HttpMethod @Nullable [] includeHttpMethods, HttpMethod @Nullable [] excludeHttpMethods,
+	public MappedInterceptor(String @Nullable [] includePatterns, String @Nullable [] excludePatterns,
 			HandlerInterceptor interceptor) {
 
-		this(includePatterns, excludePatterns,includeHttpMethods,excludeHttpMethods, interceptor, null);
+		this(includePatterns, excludePatterns, null, null, interceptor, null);
 	}
 
 	/**
@@ -136,26 +139,18 @@ public MappedInterceptor(String @Nullable [] includePatterns, String @Nullable [
 	 * with a {@link WebRequestInterceptor} as the target.
 	 */
 	public MappedInterceptor(String @Nullable [] includePatterns, WebRequestInterceptor interceptor) {
-		this(includePatterns, null,null,null, interceptor);
-	}
-	/**
-	 * Variant of
-	 * {@link #MappedInterceptor(String[], String[], HttpMethod[], HttpMethod[], HandlerInterceptor, PathPatternParser)}
-	 * with a {@link WebRequestInterceptor} as the target.
-	 */
-	public MappedInterceptor(HttpMethod @Nullable [] includeHttpMethods, WebRequestInterceptor interceptor) {
-		this(null, null,includeHttpMethods ,null, interceptor);
+		this(includePatterns, null, interceptor);
 	}
 
 	/**
 	 * Variant of
-	 * {@link #MappedInterceptor(String[], String[], HttpMethod[], HttpMethod[] , HandlerInterceptor, PathPatternParser)}
+	 * {@link #MappedInterceptor(String[], String[], HttpMethod[], HttpMethod[], HandlerInterceptor, PathPatternParser)}
 	 * with a {@link WebRequestInterceptor} as the target.
 	 */
-	public MappedInterceptor(String @Nullable [] includePatterns, String @Nullable [] excludePatterns, HttpMethod @Nullable [] includeHttpMethods, HttpMethod @Nullable [] excludeHttpMethods,
+	public MappedInterceptor(String @Nullable [] includePatterns, String @Nullable [] excludePatterns,
 			WebRequestInterceptor interceptor) {
 
-		this(includePatterns, excludePatterns,includeHttpMethods,excludeHttpMethods, new WebRequestHandlerInterceptorAdapter(interceptor));
+		this(includePatterns, excludePatterns, null, null, new WebRequestHandlerInterceptorAdapter(interceptor), null);
 	}
 
 
@@ -228,7 +223,7 @@ public PathMatcher getPathMatcher() {
 	 */
 	public boolean matches(HttpServletRequest request) {
 		Object path = ServletRequestPathUtils.getCachedPath(request);
-		HttpMethod method = HttpMethod.valueOf(request.getMethod());
+		HttpMethod httpMethod = HttpMethod.valueOf(request.getMethod());
 		if (this.pathMatcher != defaultPathMatcher) {
 			path = path.toString();
 		}
@@ -241,47 +236,37 @@ public boolean matches(HttpServletRequest request) {
 			}
 		}
 		if (!ObjectUtils.isEmpty(this.excludeHttpMethods)) {
-			for (MethodAdapter adapter : this.excludeHttpMethods) {
-				if (adapter.match(method)){
+			for (HttpMethod excluded : this.excludeHttpMethods) {
+				if (excluded == httpMethod) {
 					return false;
 				}
 			}
 		}
-		if (ObjectUtils.isEmpty(this.includePatterns) && ObjectUtils.isEmpty(this.includeHttpMethods)) {
-			return true;
-		}
-		if (!ObjectUtils.isEmpty(this.includePatterns) && ObjectUtils.isEmpty(this.includeHttpMethods)) {
+		if (!ObjectUtils.isEmpty(this.includePatterns)) {
+			boolean match = false;
 			for (PatternAdapter adapter : this.includePatterns) {
 				if (adapter.match(path, isPathContainer, this.pathMatcher)) {
-					return true;
+					match = true;
+					break;
 				}
 			}
-		}
-		if (!ObjectUtils.isEmpty(this.includeHttpMethods) && ObjectUtils.isEmpty(this.includePatterns)) {
-			for (MethodAdapter adapter : this.includeHttpMethods) {
-				if (adapter.match(method)) {
-					return true;
-				}
+			if (!match) {
+				return false;
 			}
 		}
-		if (!ObjectUtils.isEmpty(this.includePatterns) && !ObjectUtils.isEmpty(this.includeHttpMethods)) {
+		if (!ObjectUtils.isEmpty(this.includeHttpMethods)) {
 			boolean match = false;
-			for (MethodAdapter methodAdapter : this.includeHttpMethods) {
-				if (methodAdapter.match(method)) {
+			for (HttpMethod included : this.includeHttpMethods) {
+				if (included == httpMethod) {
 					match = true;
 					break;
 				}
 			}
 			if (!match) {
 				return false;
 			}
-			for (PatternAdapter pathAdapter : this.includePatterns) {
-				if (pathAdapter.match(path, isPathContainer, pathMatcher)) {
-					return true;
-				}
-			}
 		}
-		return false;
+		return true;
 	}
 
 
@@ -365,40 +350,4 @@ public boolean match(Object path, boolean isPathContainer, PathMatcher pathMatch
 		}
 	}
 
-	/**
-	 * Adapts {@link HttpMethod} instances for internal matching purposes.
-	 *
-	 * <p>Encapsulates an {@link HttpMethod} and provides matching functionality.
-	 * Also provides a utility method to initialize arrays of {@code MethodAdapter}
-	 * instances from arrays of {@link HttpMethod}.</p>
-	 *
-	 * @since 7.0.x
-	 */
-	private static class MethodAdapter {
-
-		private final @Nullable HttpMethod httpMethod;
-
-		public MethodAdapter(@Nullable HttpMethod httpMethod) {
-			this.httpMethod = httpMethod;
-		}
-
-		public boolean match(HttpMethod method) {
-			return this.httpMethod == method;
-		}
-
-		public @Nullable HttpMethod  getHttpMethod() {
-			return this.httpMethod;
-		}
-
-		private static MethodAdapter @Nullable [] initHttpMethods(HttpMethod @Nullable [] methods) {
-			if (ObjectUtils.isEmpty(methods)) {
-				return null;
-			}
-			return Arrays.stream(methods)
-					.map(MethodAdapter::new)
-					.toArray(MethodAdapter[]::new);
-		}
-
-	}
-
 }