org.javers.core.diff.appenders.CorePropertyChangeAppender Maven / Gradle / Ivy

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

JaVers - object auditing and diff framework for Java

There is a newer version: 7.6.2

package org.javers.core.diff.appenders;

import org.javers.core.diff.NodePair;
import org.javers.core.diff.changetype.PropertyChange;
import org.javers.core.metamodel.object.GlobalId;
import org.javers.core.metamodel.type.JaversProperty;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.lang.reflect.Type;

import static org.javers.core.metamodel.type.JaversType.DEFAULT_TYPE_PARAMETER;

/**
 * @author bartosz walacik
 */
public abstract class CorePropertyChangeAppender implements PropertyChangeAppender {
    private static final Logger logger = LoggerFactory.getLogger(CorePropertyChangeAppender.class);

    /**
     * JaVers needs to know actual Class of elements stored in your Collections and Maps. 

     * Wildcards (e.g. Set<?>), unbounded type parameters (e.g. Set<T>) 

     * or missing parameters (e.g. Set) are defaulted to Object.class.
     * 


     * For Collections of Values it's a reasonable guess 

     * but for Collections of Entities or ValueObjects you should use fully parametrized types (e.g. Set<Person>).
     */
    public static final String GENERIC_TYPE_NOT_PARAMETRIZED = "GENERIC_TYPE_NOT_PARAMETRIZED";

    public static void renderNotParametrizedWarningIfNeeded(Type parameterType, String parameterName, String colType, JaversProperty property){
        if (parameterType == DEFAULT_TYPE_PARAMETER){
            logger.warn("Unknown {} type in {} property: {}. Defaulting to {}, see {}.{}",
                    parameterName,
                    colType,
                    property.toString(),
                    DEFAULT_TYPE_PARAMETER.getSimpleName(),
                    CorePropertyChangeAppender.class.getSimpleName(),
                    GENERIC_TYPE_NOT_PARAMETRIZED);
        }
    }

    @Override
    final public T calculateChanges(NodePair pair, JaversProperty property) {
        Object leftValue =  pair.getLeftDehydratedPropertyValueAndSanitize(property);
        Object rightValue = pair.getRightDehydratedPropertyValueAndSanitize(property);
        return calculateChanges(leftValue, rightValue, pair, property);
    }

    protected abstract T calculateChanges(Object leftValue, Object rightValue, NodePair pair, JaversProperty property);
}