AgentMap.java

/*
 * This file is part of NucleusFramework for Bukkit, licensed under the MIT License (MIT).
 *
 * Copyright (c) JCThePants (www.jcwhatever.com)
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

package com.jcwhatever.nucleus.collections.observer.agent;

import com.jcwhatever.nucleus.collections.wrap.MapWrapper;
import com.jcwhatever.nucleus.collections.wrap.SyncStrategy;
import com.jcwhatever.nucleus.mixins.IDisposable;
import com.jcwhatever.nucleus.utils.CollectionUtils;
import com.jcwhatever.nucleus.utils.PreCon;
import com.jcwhatever.nucleus.utils.observer.ISubscriber;
import com.jcwhatever.nucleus.utils.observer.ISubscriberAgent;
import com.jcwhatever.nucleus.utils.observer.Subscriber;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import javax.annotation.Nullable;

/**
 * A map of {@link ISubscriberAgent} which automatically removes agents
 * when they are disposed.
 *
 * <p>Assumes the agent is properly implemented and calls the {@link ISubscriber#unsubscribe} method
 * of all {@link ISubscriber} instances that are observing it when it's disposed.</p>
 *
 * <p>The map has its own internal subscriber which is used to observe the agents in
 * the map. If an implementation wishes to add its own subscriber, it can do so by
 * passing it into the constructor.</p>
 *
 * <p>Implementations may need to use their own synchronization object, in which case it can be
 * passed in via the constructor using a {@link SyncStrategy}.</p>
 *
 * <p>The maps iterators must be used inside a synchronized block which locks the
 * map instance. Otherwise, a {@link java.lang.IllegalStateException} is thrown.</p>
 */
public abstract class AgentMap<K, V extends ISubscriberAgent>
        extends MapWrapper<K, V> implements IDisposable {

    private final MapSubscriber _mapSubscriber;

    private volatile boolean _isDisposed;

    /**
     * Constructor.
     *
     * <p>Synchronizes self and provides own subscriber agent.</p>
     */
    public AgentMap() {
        this(SyncStrategy.SYNC, null);
    }

    /**
     * Constructor.
     *
     * @param strategy    The synchronization strategy to use.
     * @param subscriber  The collection subscriber to use. Optional. A new one is created if null.
     */
    public AgentMap(SyncStrategy strategy, @Nullable ISubscriber subscriber) {
        super(strategy);

        _mapSubscriber = new MapSubscriber(subscriber != null ? subscriber : new Subscriber() {});
    }

    /**
     * Get all subscribers for all agents in the map.
     */
    public List<ISubscriber> getSubscribers() {

        Collection<V> agents;

        synchronized (_sync) {
            agents = new ArrayList<>(map().values());
        }

        List<ISubscriber> result = new ArrayList<>(agents.size() * 3);

        for (ISubscriberAgent agent : agents) {
            result.addAll(agent.getSubscribers());
        }

        return result;
    }

    /**
     * Unregister a subscriber from all agents in the collection.
     *
     * @param subscriber  The subscriber to unregister.
     *
     * @return  True if the subscriber was found in 1 or more producers and removed.
     */
    public boolean unregisterAll(ISubscriber subscriber) {
        PreCon.notNull(subscriber);

        Collection<V> agents;

        synchronized (_sync) {
            agents = new ArrayList<>(map().values());
        }

        boolean isChanged = false;
        for (ISubscriberAgent agent : agents) {
            isChanged = agent.removeSubscriber(subscriber) || isChanged;
        }

        return isChanged;
    }

    /**
     * Same as {@link #put} except returns own instance
     * for chaining.
     *
     * @param key    The key.
     * @param value  The agent.
     *
     * @param <T> Self instance type.
     *
     * @return  Self for chaining.
     */
    public <T extends AgentMap<K, V>> T set(K key, V value) {
        put(key, value);

        @SuppressWarnings("unchecked")
        T self = (T)this;

        return self;
    }

    @Override
    public boolean isDisposed() {
        return _isDisposed;
    }

    @Override
    public void dispose() {
        if (_isDisposed)
            return;

        synchronized (_sync) {

            if (_isDisposed)
                return;

            _mapSubscriber.dispose();
            map().clear();

            _isDisposed = true;
        }
    }

    @Override
    protected void onPut(K key, V value) {
        if (isDisposed())
            throw new RuntimeException("Cannot use a disposed AgentMap.");

        _mapSubscriber.subscribe(value);
    }

    @Override
    protected void onRemove(Object key, V removed) {
        _mapSubscriber.safeUnregister(removed);
    }

    @Override
    protected void onClear(Collection<Entry<K, V>> entries) {
        for (Entry<K, V> entry : entries) {
            _mapSubscriber.safeUnregister(entry.getValue());
        }
    }

    private class MapSubscriber extends CollectionSubscriber {

        MapSubscriber(ISubscriber subscriber) {
            super(subscriber);
        }

        @Override
        protected void removeFromCollection(ISubscriberAgent agent) {
            synchronized (_sync) {
                //noinspection SuspiciousMethodCalls
                CollectionUtils.removeValue(map(), agent);
            }
        }
    }
}