001/*
002 * jPOS Project [http://jpos.org]
003 * Copyright (C) 2000-2026 jPOS Software SRL
004 *
005 * This program is free software: you can redistribute it and/or modify
006 * it under the terms of the GNU Affero General Public License as
007 * published by the Free Software Foundation, either version 3 of the
008 * License, or (at your option) any later version.
009 *
010 * This program is distributed in the hope that it will be useful,
011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
013 * GNU Affero General Public License for more details.
014 *
015 * You should have received a copy of the GNU Affero General Public License
016 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
017 */
018
019package org.jpos.space;
020
021import java.util.Set;
022
023/**
024 * @author Kris, Bharavi, Alejandro
025 * @version $Revision$ $Date$
026 */
027public interface LocalSpace<K,V> extends Space<K,V> {
028    /**
029     * add a SpaceListener associated with a given key
030     * @param key Entry's key
031     * @param listener a SpaceListener
032     */
033    void addListener(K key, SpaceListener<K, V> listener);
034
035    /**
036     * add a SpaceListener associated with a given key for a given 
037     * period of time.
038     * <b>Warning: not supported by all space implementations.</b>
039     * @param key Entry's key
040     * @param listener a SpaceListener
041     * @param timeout listener registration timeout in millis
042     */
043    void addListener(K key, SpaceListener<K, V> listener, long timeout);
044
045    /**
046     * removes a SpaceListener associated with a given key
047     * @param key Entry's key
048     * @param listener the SpaceListener
049     */
050    void removeListener(K key, SpaceListener<K, V> listener);
051
052    /**
053     * @return Set containing all keys in Space
054     */
055    Set<K> getKeySet();
056
057    /**
058     * @return number of entries in a given key
059     */
060    int size(K key);
061}