com.hazelcast.map.mapstore.MapDataStore Maven / Gradle / Ivy

package com.hazelcast.map.mapstore;

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

/**
 * Map data store general contract.
 *
 * @param  type of key to store.
 * @param  type of value to store.
 */
public interface MapDataStore {

    V add(K key, V value, long now);

    void addTransient(K key, long now);

    V addBackup(K key, V value, long now);

    void remove(K key, long now);

    void removeBackup(K key, long now);

    void reset();

    V load(K key);

    Map loadAll(Collection keys);

    /**
     * Removes keys from map store.
     * It also handles {@link com.hazelcast.nio.serialization.Data} to object conversions of keys.
     *
     * @param keys to be removed.
     */
    void removeAll(Collection keys);

    boolean loadable(K key, long lastUpdateTime, long now);

    int notFinishedOperationsCount();

    Collection flush();

    /**
     * @param key    key to be flushed
     * @param value  value to be flushed
     * @param now    now in millis
     * @param backup true calling this method for backup partition, false for owner partition.
     * @return flushed value.
     */
    V flush(K key, V value, long now, boolean backup);
}