MapReplicatorSpi.java

/*
 * Copyright 2007 The Apache Software Foundation.
 *
 * 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 net.sf.beanlib.spi.replicator;

import java.util.Map;

import net.sf.beanlib.spi.BeanTransformerSpi;

/**
 * Map Replicator SPI.
 * 
 * @author Joe D. Velopar
 */
public interface MapReplicatorSpi {
    /**
     * Map Replicator Factory SPI.
     * 
     * @author Joe D. Velopar
     */
    public static interface Factory {
        public MapReplicatorSpi newMapReplicatable(BeanTransformerSpi beanTransformer);
    }

    /**
     * Returns a replicated map.
     * 
     * @param <K> key type of the from map
     * @param <V> value type of the from map
     * @param <T> target class type
     * @param fromMap from map
     * @param toClass target class
     */
    public <K, V, T> T replicateMap(Map<K, V> fromMap, Class<T> toClass);
}