localspace.java

POS is a Java&#174 platform-based, mission-critical, ISO-8583 based financial transaction library/fr

/*
 * jPOS Project [http://jpos.org]
 * Copyright (C) 2000-2008 Alejandro P. Revilla
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package org.jpos.space;

import java.util.Set;

/**
 * @author Kris, Bharavi, Alejandro
 * @version $Revision: 2594 $ $Date: 2008-01-22 14:41:31 -0200 (Tue, 22 Jan 2008) $
 */
public interface LocalSpace extends Space {
    /**
     * add a SpaceListener associated with a given key
     * @param key Entry's key
     * @param listener a SpaceListener
     */
    public void addListener    (Object key, SpaceListener listener);

    /**
     * add a SpaceListener associated with a given key for a given 
     * period of time.
     * <b>Warning: not supported by all space implementations.</b>
     * @param key Entry's key
     * @param listener a SpaceListener
     * @param timeout 
     */
    public void addListener (Object key, SpaceListener listener, long timeout);

    /**
     * removes a SpaceListener associated with a given key
     * @param key Entry's key
     * @param listener the SpaceListener
     */
    public void removeListener (Object key, SpaceListener listener);

    /**
     * @return Set containing all keys in Space
     */
    public Set getKeySet ();

    /**
     * @return number of entries in a given key
     */
    public int size (Object key);
}