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

DATACMNS-703 - PropertyReferenceException now exposes potential matches.

Browse Source 
We now use Spring's PropertyMatches to build up the exception message and include a list of potentially meant properties.

Removed unused config file for tests along the way.

Original pull request: #125.
This commit is contained in:
Oliver Gierke
2015-05-21 19:57:28 +02:00
parent 2cb2830d59
commit d859540f92
3 changed files with 56 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
src/main/java/org/springframework/data/mapping/PropertyReferenceException.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2012-2014 the original author or authors.
* Copyright 2012-2015 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.
@@ -15,10 +15,14 @@
*/
package org.springframework.data.mapping;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import org.springframework.beans.PropertyMatches;
import org.springframework.data.util.TypeInformation;
import org.springframework.util.Assert;
import org.springframework.util.StringUtils;
/**
* Exception being thrown when creating {@link PropertyPath} instances.
@@ -29,10 +33,12 @@ public class PropertyReferenceException extends RuntimeException {
private static final long serialVersionUID = -5254424051438976570L;
private static final String ERROR_TEMPLATE = "No property %s found for type %s!";
private static final String HINTS_TEMPLATE = " Did you mean %s?";
private final String propertyName;
private final TypeInformation<?> type;
private final List<PropertyPath> alreadyResolvedPath;
private final List<String> propertyMatches;
/**
* Creates a new {@link PropertyReferenceException}.
@@ -41,7 +47,8 @@ public class PropertyReferenceException extends RuntimeException {
* @param type the type the property could not be found on.
* @param alreadyResolvedPah the previously calculated {@link PropertyPath}s.
*/
public PropertyReferenceException(String propertyName, TypeInformation<?> type, List<PropertyPath> alreadyResolvedPah) {
public PropertyReferenceException(String propertyName, TypeInformation<?> type,
List<PropertyPath> alreadyResolvedPah) {
Assert.hasText(propertyName);
Assert.notNull(type);
@@ -49,6 +56,7 @@ public class PropertyReferenceException extends RuntimeException {
this.propertyName = propertyName;
this.type = type;
this.alreadyResolvedPath = alreadyResolvedPah;
this.propertyMatches = detectPotentialMatches(propertyName, type.getType());
}
/**
@@ -76,11 +84,18 @@ public class PropertyReferenceException extends RuntimeException {
@Override
public String getMessage() {
StringBuilder builder = new StringBuilder(String.format(ERROR_TEMPLATE, propertyName, type.getType()
.getSimpleName()));
StringBuilder builder = new StringBuilder(
String.format(ERROR_TEMPLATE, propertyName, type.getType().getSimpleName()));
if (!propertyMatches.isEmpty()) {
String matches = StringUtils.collectionToDelimitedString(propertyMatches, ",", "'", "'");
builder.append(String.format(HINTS_TEMPLATE, matches));
}
if (!alreadyResolvedPath.isEmpty()) {
builder.append(" Traversed path: ").append(alreadyResolvedPath.get(0).toString()).append(".");
builder.append(" Traversed path: ");
builder.append(alreadyResolvedPath.get(0).toString());
builder.append(".");
}
return builder.toString();
@@ -105,4 +120,20 @@ public class PropertyReferenceException extends RuntimeException {
public boolean hasDeeperResolutionDepthThan(PropertyReferenceException exception) {
return this.alreadyResolvedPath.size() > exception.alreadyResolvedPath.size();
}
/**
* Detects all potential matches for the given property name and type.
*
* @param propertyName must not be {@literal null} or empty.
* @param type must not be {@literal null}.
* @return
*/
private static List<String> detectPotentialMatches(String propertyName, Class<?> type) {
List<String> result = new ArrayList<String>();
result.addAll(Arrays.asList(PropertyMatches.forField(propertyName, type).getPossibleMatches()));
result.addAll(Arrays.asList(PropertyMatches.forProperty(propertyName, type).getPossibleMatches()));
return result;
}
}