Consistent ExpressionException-style quoting of expression string and position

Issue: SPR-14942

Author: jhoeller

spring-expression/src/main/java/org/springframework/expression/EvaluationException.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2016 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.
@@ -26,7 +26,24 @@
 public class EvaluationException extends ExpressionException {
 
 	/**
-	 * Creates a new expression evaluation exception.
+	 * Create a new expression evaluation exception.
+	 * @param message description of the problem that occurred
+	 */
+	public EvaluationException(String message) {
+		super(message);
+	}
+
+	/**
+	 * Create a new expression evaluation exception.
+	 * @param message description of the problem that occurred
+	 * @param cause the underlying cause of this exception
+	 */
+	public EvaluationException(String message, Throwable cause) {
+		super(message,cause);
+	}
+
+	/**
+	 * Create a new expression evaluation exception.
 	 * @param position the position in the expression where the problem occurred
 	 * @param message description of the problem that occurred
 	 */
@@ -35,7 +52,7 @@ public EvaluationException(int position, String message) {
 	}
 
 	/**
-	 * Creates a new expression evaluation exception.
+	 * Create a new expression evaluation exception.
 	 * @param expressionString the expression that could not be evaluated
 	 * @param message description of the problem that occurred
 	 */
@@ -44,7 +61,7 @@ public EvaluationException(String expressionString, String message) {
 	}
 
 	/**
-	 * Creates a new expression evaluation exception.
+	 * Create a new expression evaluation exception.
 	 * @param position the position in the expression where the problem occurred
 	 * @param message description of the problem that occurred
 	 * @param cause the underlying cause of this exception
@@ -53,16 +70,4 @@ public EvaluationException(int position, String message, Throwable cause) {
 		super(position, message, cause);
 	}
 
-	/**
-	 * Creates a new expression evaluation exception.
-	 * @param message description of the problem that occurred
-	 */
-	public EvaluationException(String message) {
-		super(message);
-	}
-
-	public EvaluationException(String message, Throwable cause) {
-		super(message,cause);
-	}
-
 }

spring-expression/src/main/java/org/springframework/expression/ExpressionException.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2015 the original author or authors.
+ * Copyright 2002-2016 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.
@@ -20,75 +20,76 @@
  * Super class for exceptions that can occur whilst processing expressions.
  *
  * @author Andy Clement
+ * @author Phil Webb
  * @since 3.0
  */
 @SuppressWarnings("serial")
 public class ExpressionException extends RuntimeException {
 
 	protected String expressionString;
 
-	protected int position;  // -1 if not known - but should be known in all reasonable cases
+	protected int position;  // -1 if not known; should be known in all reasonable cases
 
 
 	/**
 	 * Construct a new expression exception.
-	 * @param expressionString the expression string
 	 * @param message a descriptive message
 	 */
-	public ExpressionException(String expressionString, String message) {
+	public ExpressionException(String message) {
 		super(message);
-		this.position = -1;
-		this.expressionString = expressionString;
 	}
 
 	/**
 	 * Construct a new expression exception.
-	 * @param expressionString the expression string
-	 * @param position the position in the expression string where the problem occurred
 	 * @param message a descriptive message
+	 * @param cause the underlying cause of this exception
 	 */
-	public ExpressionException(String expressionString, int position, String message) {
-		super(message);
-		this.position = position;
-		this.expressionString = expressionString;
+	public ExpressionException(String message, Throwable cause) {
+		super(message, cause);
 	}
 
 	/**
 	 * Construct a new expression exception.
-	 * @param position the position in the expression string where the problem occurred
+	 * @param expressionString the expression string
 	 * @param message a descriptive message
 	 */
-	public ExpressionException(int position, String message) {
+	public ExpressionException(String expressionString, String message) {
 		super(message);
-		this.position = position;
+		this.expressionString = expressionString;
+		this.position = -1;
 	}
 
 	/**
 	 * Construct a new expression exception.
+	 * @param expressionString the expression string
 	 * @param position the position in the expression string where the problem occurred
 	 * @param message a descriptive message
-	 * @param cause the underlying cause of this exception
 	 */
-	public ExpressionException(int position, String message, Throwable cause) {
-		super(message,cause);
+	public ExpressionException(String expressionString, int position, String message) {
+		super(message);
+		this.expressionString = expressionString;
 		this.position = position;
 	}
 
 	/**
 	 * Construct a new expression exception.
+	 * @param position the position in the expression string where the problem occurred
 	 * @param message a descriptive message
 	 */
-	public ExpressionException(String message) {
+	public ExpressionException(int position, String message) {
 		super(message);
+		this.position = position;
 	}
 
 	/**
 	 * Construct a new expression exception.
+	 * @param position the position in the expression string where the problem occurred
 	 * @param message a descriptive message
 	 * @param cause the underlying cause of this exception
 	 */
-	public ExpressionException(String message, Throwable cause) {
+	public ExpressionException(int position, String message, Throwable cause) {
 		super(message,cause);
+		this.position = position;
 	}
 
 
@@ -107,8 +108,9 @@ public final int getPosition() {
 	}
 
 	/**
-	 * Return the exception message. Since Spring 4.0 this method returns the
-	 * same result as {@link #toDetailedString()}.
+	 * Return the exception message.
+	 * As of Spring 4.0, this method returns the same result as {@link #toDetailedString()}.
+	 * @see #getSimpleMessage()
 	 * @see java.lang.Throwable#getMessage()
 	 */
 	@Override
@@ -123,11 +125,11 @@ public String getMessage() {
 	public String toDetailedString() {
 		if (this.expressionString != null) {
 			StringBuilder output = new StringBuilder();
-			output.append("Expression '");
+			output.append("Expression [");
 			output.append(this.expressionString);
-			output.append("'");
-			if (this.position != -1) {
-				output.append(" @ ");
+			output.append("]");
+			if (this.position >= 0) {
+				output.append(" @");
 				output.append(this.position);
 			}
 			output.append(": ");
@@ -142,6 +144,7 @@ public String toDetailedString() {
 	/**
 	 * Return the exception simple message without including the expression
 	 * that caused the failure.
+	 * @since 4.0
 	 */
 	public String getSimpleMessage() {
 		return super.getMessage();

spring-expression/src/main/java/org/springframework/expression/ParseException.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2016 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.
@@ -26,7 +26,7 @@
 public class ParseException extends ExpressionException {
 
 	/**
-	 * Creates a new expression parsing exception.
+	 * Create a new expression parsing exception.
 	 * @param expressionString the expression string that could not be parsed
 	 * @param position the position in the expression string where the problem occurred
 	 * @param message description of the problem that occurred
@@ -36,7 +36,7 @@ public ParseException(String expressionString, int position, String message) {
 	}
 
 	/**
-	 * Creates a new expression parsing exception.
+	 * Create a new expression parsing exception.
 	 * @param position the position in the expression string where the problem occurred
 	 * @param message description of the problem that occurred
 	 * @param cause the underlying cause of this exception
@@ -46,7 +46,7 @@ public ParseException(int position, String message, Throwable cause) {
 	}
 
 	/**
-	 * Creates a new expression parsing exception.
+	 * Create a new expression parsing exception.
 	 * @param position the position in the expression string where the problem occurred
 	 * @param message description of the problem that occurred
 	 */

spring-expression/src/main/java/org/springframework/expression/spel/SpelEvaluationException.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * Copyright 2002-2016 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.
@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.springframework.expression.spel;
 
 import org.springframework.expression.EvaluationException;
@@ -23,6 +24,7 @@
  * message. See {@link SpelMessage} for the list of all possible messages that can occur.
  *
  * @author Andy Clement
+ * @author Juergen Hoeller
  * @since 3.0
  */
 @SuppressWarnings("serial")
@@ -34,62 +36,46 @@ public class SpelEvaluationException extends EvaluationException {
 
 
 	public SpelEvaluationException(SpelMessage message, Object... inserts) {
-		super(message.formatMessage(0, inserts)); // TODO poor position information, can the callers not really supply something?
+		super(message.formatMessage(inserts));
 		this.message = message;
 		this.inserts = inserts;
 	}
 
 	public SpelEvaluationException(int position, SpelMessage message, Object... inserts) {
-		super(position, message.formatMessage(position, inserts));
+		super(position, message.formatMessage(inserts));
 		this.message = message;
 		this.inserts = inserts;
 	}
 
-	public SpelEvaluationException(int position, Throwable cause,
-			SpelMessage message, Object... inserts) {
-		super(position,message.formatMessage(position,inserts),cause);
+	public SpelEvaluationException(int position, Throwable cause, SpelMessage message, Object... inserts) {
+		super(position, message.formatMessage(inserts),cause);
 		this.message = message;
 		this.inserts = inserts;
 	}
 
 	public SpelEvaluationException(Throwable cause, SpelMessage message, Object... inserts) {
-		super(message.formatMessage(0,inserts),cause);
+		super(message.formatMessage(inserts), cause);
 		this.message = message;
 		this.inserts = inserts;
 	}
 
 
 	/**
-	 * @return a formatted message with inserts applied
+	 * Set the position in the related expression which gave rise to this exception.
 	 */
-	@Override
-	public String getMessage() {
-		if (this.message != null) {
-			return this.message.formatMessage(this.position, this.inserts);
-		}
-		else {
-			return super.getMessage();
-		}
+	public void setPosition(int position) {
+		this.position = position;
 	}
 
 	/**
-	 * @return the message code
+	 * Return the message code.
 	 */
 	public SpelMessage getMessageCode() {
 		return this.message;
 	}
 
 	/**
-	 * Set the position in the related expression which gave rise to this exception.
-	 *
-	 * @param position the position in the expression that gave rise to the exception
-	 */
-	public void setPosition(int position) {
-		this.position = position;
-	}
-
-	/**
-	 * @return the message inserts
+	 * Return the message inserts.
 	 */
 	public Object[] getInserts() {
 		return this.inserts;