/*******************************************************************************
 * Copyright (c) 2006, 2007 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     Brad Reynolds - bug 164653
 *     Matthew Hall - bug 245183
 *******************************************************************************/

module org.eclipse.core.databinding.observable.map.ObservableMap;

import java.lang.all;

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

import org.eclipse.core.databinding.observable.AbstractObservable;
import org.eclipse.core.databinding.observable.ObservableTracker;
import org.eclipse.core.databinding.observable.Realm;

/**
 * 
 * <p>
 * This class is thread safe. All state accessing methods must be invoked from
 * the {@link Realm#isCurrent() current realm}. Methods for adding and removing
 * listeners may be invoked from any thread.
 * </p>
 * @since 1.0
 */
public class ObservableMap : AbstractObservable , IObservableMap {

    protected Map wrappedMap;

    private bool stale = false;
    
    /**
     * @param wrappedMap
     */
    public this(Map wrappedMap) {
        this(Realm.getDefault(), wrappedMap);
    }

    /**
     * @param realm 
     * @param wrappedMap
     */
    public this(Realm realm, Map wrappedMap) {
        super(realm);
        this.wrappedMap = wrappedMap;
    }
    
    public synchronized void addMapChangeListener(IMapChangeListener listener) {
        addListener(MapChangeEvent.TYPE, listener);
    }

    public synchronized void removeMapChangeListener(IMapChangeListener listener) {
        removeListener(MapChangeEvent.TYPE, listener);
    }

    protected void getterCalled() {
        ObservableTracker.getterCalled(this);
    }

    protected void fireMapChange(MapDiff diff) {
        checkRealm();
        
        // fire general change event first
        super.fireChange();

        fireEvent(new MapChangeEvent(this, diff));
    }

    public bool containsKey(Object key) {
        getterCalled();
        return wrappedMap.containsKey(key);
    }

    public bool containsValue(Object value) {
        getterCalled();
        return wrappedMap.containsValue(value);
    }

    public Set entrySet() {
        getterCalled();
        return wrappedMap.entrySet();
    }

    public Object get(Object key) {
        getterCalled();
        return wrappedMap.get(key);
    }

    public bool isEmpty() {
        getterCalled();
        return wrappedMap.isEmpty();
    }

    public Set keySet() {
        getterCalled();
        return wrappedMap.keySet();
    }

    public int size() {
        getterCalled();
        return wrappedMap.size();
    }

    public Collection values() {
        getterCalled();
        return wrappedMap.values();
    }

    /**
     * Returns the stale state.  Must be invoked from the current realm.
     * 
     * @return stale state
     */
    public bool isStale() {
        checkRealm();
        return stale;
    }

    /**
     * Sets the stale state.  Must be invoked from the current realm.
     * 
     * @param stale
     *            The stale state to set. This will fire a stale event if the
     *            given bool is true and this observable set was not already
     *            stale.
     */
    public void setStale(bool stale) {
        checkRealm();
        bool wasStale = this.stale;
        this.stale = stale;
        if (!wasStale && stale) {
            fireStale();
        }
    }

    public Object put(Object key, Object value) {
        throw new UnsupportedOperationException();
    }

    public Object remove(Object key) {
        throw new UnsupportedOperationException();
    }

    public void clear() {
        throw new UnsupportedOperationException();
    }

    public void putAll(Map arg0) {
        throw new UnsupportedOperationException();
    }

    public synchronized void dispose() {
        super.dispose();
    }

    public override equals_t opEquals(Object obj) {
        getterCalled();

        if (obj is this)
            return true;
        if (obj is null)
            return false;
        if (getClass() is obj.getClass()) {
            return wrappedMap.equals((cast(ObservableMap) obj).wrappedMap);
        }

        return wrappedMap.equals(obj);
    }

    public override hash_t toHash() {
        getterCalled();

        return wrappedMap.hashCode();
    }
}