MapTransformationFunction.java

package io.monokkel.core.utils;

import java.util.Map;

/**
 * Created by tarjei on 20/09/14.
 */
public interface MapTransformationFunction<K,V> {

    /**
     *
     * This method is intended to receive a key and a value that is intended to be transformed.
     * The transformationMap is intended to contain some sort of rules that will be utilized to
     * perform the transformation.
     *
     *
     * @param key is the key value of the value from the map that is going to be transformed
     * @param value the corresponding value from the map that is the subject of transformation
     * @param transformationMap the data that is used as settings for the transformation. The map that is inserted here
     *                          should be as non-verbose as possible.
     * @return the transformed data
     */
    public V transform(K key, V value, Map<K,V> transformationMap);
}