org.dominokit.jackson.deser.bean.IdentityDeserializationInfo Maven / Gradle / Ivy
/*
* Copyright 2013 Nicolas Morel
*
* 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
*
* http://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.dominokit.jackson.deser.bean;
import com.fasterxml.jackson.annotation.ObjectIdGenerator.IdKey;
import org.dominokit.jackson.JsonDeserializationContext;
import org.dominokit.jackson.stream.JsonReader;
/** Contains identity information for deserialization process. */
public interface IdentityDeserializationInfo {
/**
* getPropertyName
*
* @return a {@link String} name of the identifier property
*/
String getPropertyName();
/**
* isProperty
*
* @return true if the identifier is also a property of the bean
*/
boolean isProperty();
/**
* newIdKey
*
* @param id Identifier
* @return a new {@link com.fasterxml.jackson.annotation.ObjectIdGenerator.IdKey}
*/
IdKey newIdKey(Object id);
/**
* Reads the id and returns it.
*
* @param reader a {@link JsonReader} reader
* @param ctx a {@link JsonDeserializationContext} context of the deserialization process
* @return the identifier
*/
Object readId(JsonReader reader, JsonDeserializationContext ctx);
}