Polish PathPattern parser (including package change to web.util.pattern)

Issue: SPR-15531

Author: jhoeller

spring-web/src/main/java/org/springframework/web/cors/reactive/UrlBasedCorsConfigurationSource.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2017 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.
@@ -25,7 +25,7 @@
 import org.springframework.web.cors.CorsConfiguration;
 import org.springframework.web.server.ServerWebExchange;
 import org.springframework.web.server.support.HttpRequestPathHelper;
-import org.springframework.web.util.ParsingPathMatcher;
+import org.springframework.web.util.pattern.ParsingPathMatcher;
 
 /**
  * Provide a per reactive request {@link CorsConfiguration} instance based on a

spring-web/src/main/java/org/springframework/web/util/patterns/CaptureTheRestPathElement.java renamed to spring-web/src/main/java/org/springframework/web/util/pattern/CaptureTheRestPathElement.java

@@ -14,19 +14,21 @@
  * limitations under the License.
  */
 
-package org.springframework.web.util.patterns;
+package org.springframework.web.util.pattern;
 
-import org.springframework.web.util.patterns.PathPattern.MatchingContext;
+import org.springframework.web.util.pattern.PathPattern.MatchingContext;
 
 /**
  * A path element representing capturing the rest of a path. In the pattern
  * '/foo/{*foobar}' the /{*foobar} is represented as a {@link CaptureTheRestPathElement}.
  *
  * @author Andy Clement
+ * @since 5.0
  */
 class CaptureTheRestPathElement extends PathElement {
 
-	private String variableName;
+	private final String variableName;
+
 
 	/**
 	 * @param pos position of the path element within the path pattern text
@@ -35,9 +37,10 @@ class CaptureTheRestPathElement extends PathElement {
 	 */
 	CaptureTheRestPathElement(int pos, char[] captureDescriptor, char separator) {
 		super(pos, separator);
-		variableName = new String(captureDescriptor, 2, captureDescriptor.length - 3);
+		this.variableName = new String(captureDescriptor, 2, captureDescriptor.length - 3);
 	}
 
+
 	@Override
 	public boolean matches(int candidateIndex, MatchingContext matchingContext) {
 		// No need to handle 'match start' checking as this captures everything
@@ -59,10 +62,6 @@ public boolean matches(int candidateIndex, MatchingContext matchingContext) {
 		return true;
 	}
 
-	public String toString() {
-		return "CaptureTheRest(/{*" + variableName + "})";
-	}
-
 	@Override
 	public int getNormalizedLength() {
 		return 1;
@@ -77,4 +76,10 @@ public int getWildcardCount() {
 	public int getCaptureCount() {
 		return 1;
 	}
-}
+
+
+	public String toString() {
+		return "CaptureTheRest(/{*" + this.variableName + "})";
+	}
+
+}

spring-web/src/main/java/org/springframework/web/util/patterns/CaptureVariablePathElement.java renamed to spring-web/src/main/java/org/springframework/web/util/pattern/CaptureVariablePathElement.java

@@ -14,24 +14,25 @@
  * limitations under the License.
  */
 
-package org.springframework.web.util.patterns;
+package org.springframework.web.util.pattern;
 
 import java.util.regex.Matcher;
-
-import org.springframework.web.util.patterns.PathPattern.MatchingContext;
+import java.util.regex.Pattern;
 
 /**
  * A path element representing capturing a piece of the path as a variable. In the pattern
  * '/foo/{bar}/goo' the {bar} is represented as a {@link CaptureVariablePathElement}. There
  * must be at least one character to bind to the variable.
  *
  * @author Andy Clement
+ * @since 5.0
  */
 class CaptureVariablePathElement extends PathElement {
 
-	private String variableName;
+	private final String variableName;
+
+	private Pattern constraintPattern;
 
-	private java.util.regex.Pattern constraintPattern;
 
 	/**
 	 * @param pos the position in the pattern of this capture element
@@ -48,43 +49,47 @@ class CaptureVariablePathElement extends PathElement {
 		}
 		if (colon == -1) {
 			// no constraint
-			variableName = new String(captureDescriptor, 1, captureDescriptor.length - 2);
+			this.variableName = new String(captureDescriptor, 1, captureDescriptor.length - 2);
 		}
 		else {
-			variableName = new String(captureDescriptor, 1, colon - 1);
+			this.variableName = new String(captureDescriptor, 1, colon - 1);
 			if (caseSensitive) {
-				constraintPattern = java.util.regex.Pattern
-						.compile(new String(captureDescriptor, colon + 1, captureDescriptor.length - colon - 2));
+				this.constraintPattern = Pattern.compile(
+						new String(captureDescriptor, colon + 1, captureDescriptor.length - colon - 2));
 			}
 			else {
-				constraintPattern = java.util.regex.Pattern.compile(
+				this.constraintPattern = Pattern.compile(
 						new String(captureDescriptor, colon + 1, captureDescriptor.length - colon - 2),
-						java.util.regex.Pattern.CASE_INSENSITIVE);
+						Pattern.CASE_INSENSITIVE);
 			}
 		}
 	}
 
+
 	@Override
-	public boolean matches(int candidateIndex, MatchingContext matchingContext) {
+	public boolean matches(int candidateIndex, PathPattern.MatchingContext matchingContext) {
 		int nextPos = matchingContext.scanAhead(candidateIndex);
 		// There must be at least one character to capture:
 		if (nextPos == candidateIndex) {
 			return false;
 		}
+
 		CharSequence candidateCapture = null;
-		if (constraintPattern != null) {
+		if (this.constraintPattern != null) {
 			// TODO possible optimization - only regex match if rest of pattern matches? Benefit likely to vary pattern to pattern
 			candidateCapture = new SubSequence(matchingContext.candidate, candidateIndex, nextPos);
-			Matcher m = constraintPattern.matcher(candidateCapture);
-			if (m.groupCount() != 0) {
-				throw new IllegalArgumentException("No capture groups allowed in the constraint regex: " + constraintPattern.pattern());
+			Matcher matcher = constraintPattern.matcher(candidateCapture);
+			if (matcher.groupCount() != 0) {
+				throw new IllegalArgumentException(
+						"No capture groups allowed in the constraint regex: " + this.constraintPattern.pattern());
 			}
-			if (!m.matches()) {
+			if (!matcher.matches()) {
 				return false;
 			}
 		}
+
 		boolean match = false;
-		if (next == null) {
+		if (this.next == null) {
 			if (matchingContext.determineRemainingPath && nextPos > candidateIndex) {
 				matchingContext.remainingPathIndex = nextPos;
 				match = true;
@@ -101,14 +106,16 @@ public boolean matches(int candidateIndex, MatchingContext matchingContext) {
 		}
 		else {
 			if (matchingContext.isMatchStartMatching && nextPos == matchingContext.candidateLength) {
-				match = true; // no more data but matches up to this point
+				match = true;  // no more data but matches up to this point
 			}
 			else {
-				match = next.matches(nextPos, matchingContext);
+				match = this.next.matches(nextPos, matchingContext);
 			}
 		}
+
 		if (match && matchingContext.extractingVariables) {
-			matchingContext.set(variableName, new String(matchingContext.candidate, candidateIndex, nextPos - candidateIndex));
+			matchingContext.set(this.variableName,
+					new String(matchingContext.candidate, candidateIndex, nextPos - candidateIndex));
 		}
 		return match;
 	}
@@ -117,10 +124,6 @@ public String getVariableName() {
 		return this.variableName;
 	}
 
-	public String toString() {
-		return "CaptureVariable({" + variableName + (constraintPattern == null ? "" : ":" + constraintPattern.pattern()) + "})";
-	}
-
 	@Override
 	public int getNormalizedLength() {
 		return 1;
@@ -140,4 +143,11 @@ public int getCaptureCount() {
 	public int getScore() {
 		return CAPTURE_VARIABLE_WEIGHT;
 	}
-}
+
+
+	public String toString() {
+		return "CaptureVariable({" + this.variableName +
+				(this.constraintPattern != null ? ":" + this.constraintPattern.pattern() : "") + "})";
+	}
+
+}