Skip to content

Commit

Permalink
Add a properties setter to ProblemDetail
Browse files Browse the repository at this point in the history
Mainly to allow Kotlin idiomatic properties assignment.

Closes gh-31430
  • Loading branch information
sdeleuze committed Oct 17, 2023
1 parent 7a60e20 commit 875eeab
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,18 @@ public void setProperty(String name, @Nullable Object value) {
this.properties.put(name, value);
}

/**
* Setter for the {@link #getProperties() properties map}.
* <p>By default, this is not set.
* <p>When Jackson JSON is present on the classpath, any properties set here
* are rendered as top level key-value pairs in the output JSON. Otherwise,
* they are rendered as a {@code "properties"} sub-map.
* @param properties the properties map
*/
public void setProperties(@Nullable Map<String, Object> properties) {
this.properties = properties;
}

/**
* Return a generic map of properties that are not known ahead of time,
* possibly {@code null} if no properties have been added. To add a property,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
/*
* Copyright 2002-2023 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.http

import org.assertj.core.api.Assertions.assertThat
import org.junit.jupiter.api.Test

/**
* Kotlin tests for [ProblemDetail].
*/
class KotlinProblemDetailTests {

@Test // gh-31430
fun propertiesSetter() {
val problemDetail = ProblemDetail()
val map = mapOf("foo" to "bar")
problemDetail.properties = map
assertThat(problemDetail.properties).isEqualTo(map)
}

}

0 comments on commit 875eeab

Please sign in to comment.