com.github.molcikas.photon.blueprints.EntityFieldValueMapping Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of photon-core Show documentation

null

There is a newer version: 0.10.2

package com.github.molcikas.photon.blueprints;

import java.util.Map;

/**
 * Interface for custom mapping for getting and setting field values on an entity for a given database column.
 *
 * @param  - The entity class type
 * @param  - The field class type
 */
public interface EntityFieldValueMapping
{
    /**
     * Get the field value from the entity instance that maps to the database column.
     *
     * @param entityInstance - The entity instance
     * @return - The field value
     */
    F getFieldValue(E entityInstance);

    /**
     * Set the field value(s) on a given entity instance that maps to the database column. The value can be applied
     * directly to the entity instance, or the method can return a map of values that will be applied to the entity
     * instance (to avoid having to write reflection code directly in this method).
     *
     * @param entityInstance - The entity instance
     * @param fieldValue - The field value
     * @return - The field values to set on the entity. The key is the field name and the value is the field value. If
     *           the value was applied directly to the entity instance, then null or an empty map can be returned.
     */
    Map setFieldValue(E entityInstance, F fieldValue);
}