Skip to content

Commit

Permalink
Include argument name in MethodArgumentTypeMismatchException message
Browse files Browse the repository at this point in the history
Closes gh-33573
  • Loading branch information
simonbasle committed Oct 3, 2024
1 parent 0b3b139 commit b54420f
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ public MethodArgumentTypeMismatchException(@Nullable Object value,
initPropertyName(name);
}


/**
* Return the name of the method argument.
*/
Expand All @@ -60,4 +59,9 @@ public MethodParameter getParameter() {
return this.parameter;
}

@Override
public String getMessage() {
return "Method parameter '" + getName() + "': " + super.getMessage();
}

}
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
/*
* Copyright 2002-2024 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.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/

package org.springframework.web.method.annotation;

import org.junit.jupiter.api.Test;

import static org.assertj.core.api.Assertions.assertThat;

class MethodArgumentTypeMismatchExceptionTests {

@Test //gh-33573
void messageIncludesParameterName() {
@SuppressWarnings("DataFlowIssue")
MethodArgumentTypeMismatchException ex = new MethodArgumentTypeMismatchException(
"mismatched value", Integer.class, "paramOne", null, null);

assertThat(ex).hasMessage("Method parameter 'paramOne': Failed to convert value of type " +
"'java.lang.String' to required type 'java.lang.Integer'");
}

}

0 comments on commit b54420f

Please sign in to comment.