From 85db7663c9824312328c356d2c435b1605251c6f Mon Sep 17 00:00:00 2001 From: Scott Leberknight <174812+sleberknight@users.noreply.github.com> Date: Tue, 8 Dec 2020 20:49:49 -0500 Subject: [PATCH] Update javadocs in JaxrsExceptionMapper (#478) * Update javadocs for buildResponseEntity method to mention the caveat about the otherData map containing an "errors" key, i.e. it is overwritten, and provide reference to JaxrsException#setOtherData where it is discussed * Static import KiwiMaps.isNotNullOrEmpty --- .../jaxrs/exception/JaxrsExceptionMapper.java | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/src/main/java/org/kiwiproject/jaxrs/exception/JaxrsExceptionMapper.java b/src/main/java/org/kiwiproject/jaxrs/exception/JaxrsExceptionMapper.java index 3b66b203..767460d6 100644 --- a/src/main/java/org/kiwiproject/jaxrs/exception/JaxrsExceptionMapper.java +++ b/src/main/java/org/kiwiproject/jaxrs/exception/JaxrsExceptionMapper.java @@ -4,6 +4,7 @@ import static java.util.Objects.isNull; import static java.util.stream.Collectors.toUnmodifiableList; import static org.apache.commons.lang3.StringUtils.isBlank; +import static org.kiwiproject.collect.KiwiMaps.isNotNullOrEmpty; import lombok.extern.slf4j.Slf4j; import org.kiwiproject.collect.KiwiMaps; @@ -78,16 +79,19 @@ public static Response.ResponseBuilder buildResponseBuilder(JaxrsException excep * Convert the given {@link JaxrsException} to a map that can be used as a JSON response entity. *

* The response entity will contain an "errors" key containing the {@link ErrorMessage} objects. - * If the exception contains any other data ({@link JaxrsException#getOtherData()}, those are inclued - * in the response entity. + * If the exception contains any other data ({@link JaxrsException#getOtherData()}), those key/value pairs + * are also included in the response entity. See the note in {@link JaxrsException#setOtherData(Map)} regarding + * the behavior if {@code otherData} contains an "errors" key. * * @param exception the exception to convert * @return a map that can be used as a response entity + * @see JaxrsException#getOtherData() + * @see JaxrsException#setOtherData(Map) */ public static Map buildResponseEntity(JaxrsException exception) { var entity = new HashMap(); - if (KiwiMaps.isNotNullOrEmpty(exception.getOtherData())) { + if (isNotNullOrEmpty(exception.getOtherData())) { entity.putAll(exception.getOtherData()); }