/*
 *    Geotoolkit - An Open Source Java GIS Toolkit
 *    http://www.geotoolkit.org
 *
 *    (C) 2008 - 2009, Geomatys
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License as published by the Free Software Foundation; either
 *    version 2.1 of the License, or (at your option) any later version.
 *
 *    This library 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
 *    Lesser General Public License for more details.
 */
package org.geotoolkit.util.collection;

import java.util.Collection;
import org.apache.sis.measure.NumberRange;

/**
 * Abstract synchronized set that define notify methods called when
 * objects are added or removed.
 * 
 * @author Johann Sorel (Geomatys)
 * @module
 */
public abstract class NotifiedCheckedSet<E> extends CheckedHashSet<E>{
    
    public NotifiedCheckedSet(final Class<E> type) {
        super(type);
    }
    
    public NotifiedCheckedSet(final Class<E> type, final int capacity) {
        super(type,capacity);
    }

    protected abstract void notifyAdd(final E item, NumberRange<Integer> range);
    
    protected abstract void notifyAdd(final Collection<? extends E> item, NumberRange<Integer> range);
    
    protected abstract void notifyRemove(final E item, NumberRange<Integer> range);
    
    @Override
    public boolean add(final E element) throws IllegalArgumentException, UnsupportedOperationException {
        if(element == null) return false;
        final boolean added = super.add(element);
        if (added) {
            notifyAdd(element, null);
        }
        return added;
    }

    @Override
    public boolean addAll(final Collection<? extends E> collection) throws IllegalArgumentException, UnsupportedOperationException {
        final boolean added = super.addAll(collection);
        if (added) {
            notifyAdd(collection, null );
        }
        return added;
    }

    @Override
    public boolean remove(final Object o) throws UnsupportedOperationException {
        final boolean removed = super.remove(o);
        if (removed) {
            notifyRemove(super.getElementType().cast(o), null );
        }
        return removed;
    }

    @Override
    public boolean removeAll(final Collection<?> c) throws UnsupportedOperationException {
        //TODO handle remove by collection events if possible
        // to avoid several calls to remove
        boolean valid = false;
        for(Object i : c){
            final boolean val = remove(i);
            if(val) valid = val;
        }
        return valid;
    }   
        
        
}