com.alachisoft.ncache.client.datastructures.DistributedMap Maven / Gradle / Ivy

Go to download
package com.alachisoft.ncache.client.datastructures;

import java.util.Collection;
import java.util.Map;


/**
 * This interface contains methods and parameters for distributed Map.
 * @param  The type of key is limited to string only.
 * @param  The type of values in the dictionary.
 */
public interface DistributedMap extends Map, DistributedDataStructure, Notifiable,Iterable {

    /**
     * Insert elements with the provided keys and values in DistributedMap.
     * @param entries
     */
    void insert(java.util.Map entries);
    /**
     * Copies the Map elements to the specified array, starting at the specified index.
     * @param array The destination array of the elements copied from map.
     * @param arrayIndex he zero-based index in array at which copying begins.
     */

    void copyTo(Entry[] array, int arrayIndex);


    /**
     * Removes the element with the specified keys from DistributedMap.
     * @param keys The keys of the elements to remove.
     * @return The number of items that were removed.
     */
    int remove(Collection keys);


    /**
     * Returns the values associated with the specified keys.
     * @param keys The keys whose values to get.
     * @return Collection of values against the provided keys.
     */
    Collection get(Collection keys);
}