org.dominokit.jacksonapt.ser.bean.IdentitySerializationInfo Maven / Gradle / Ivy

Go to download
package org.dominokit.jacksonapt.ser.bean;

import org.dominokit.jacksonapt.JsonSerializationContext;

/**
 * Contains identity informations for serialization process.
 *
 * @author Nicolas Morel
 * @version $Id: $
 */
public interface IdentitySerializationInfo {

    /**
     * isAlwaysAsId
     *
     * @return true if we should always serialize the bean as an identifier even if it has not been seralized yet
     */
    boolean isAlwaysAsId();

    /**
     * isProperty
     *
     * @return true if the identifier is also a property of the bean
     */
    boolean isProperty();

    /**
     * getPropertyName
     *
     * @return name of the identifier property
     */
    String getPropertyName();

    /**
     * getObjectId
     *
     * @param bean a T object.
     * @param ctx  a {@link org.dominokit.jacksonapt.JsonSerializationContext} object.
     * @return a {@link org.dominokit.jacksonapt.ser.bean.ObjectIdSerializer} object.
     */
    ObjectIdSerializer getObjectId(T bean, JsonSerializationContext ctx);
}