org.springframework.http.converter.json.ProblemDetailJacksonMixin Maven / Gradle / Ivy
/*
* Copyright 2002-2022 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.converter.json;
import java.util.Map;
import com.fasterxml.jackson.annotation.JsonAnyGetter;
import com.fasterxml.jackson.annotation.JsonAnySetter;
import com.fasterxml.jackson.annotation.JsonInclude;
import org.springframework.http.ProblemDetail;
import static com.fasterxml.jackson.annotation.JsonInclude.Include.NON_EMPTY;
/**
* An interface to associate Jackson annotations with
* {@link org.springframework.http.ProblemDetail} to avoid a hard dependency on
* the Jackson library.
*
* The annotations ensure the {@link ProblemDetail#getProperties() properties}
* map is unwrapped and rendered as top level JSON properties, and likewise that
* the {@code properties} map contains unknown properties from the JSON.
*
*
{@link Jackson2ObjectMapperBuilder} automatically registers this as a
* "mix-in" for {@link ProblemDetail}, which means it always applies, unless
* an {@code ObjectMapper} is instantiated directly and configured for use.
*
* @author Rossen Stoyanchev
* @since 6.0
*/
@JsonInclude(NON_EMPTY)
public interface ProblemDetailJacksonMixin {
@JsonAnySetter
void setProperty(String name, Object value);
@JsonAnyGetter
Map getProperties();
}