/*
* 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.subscriber;
import com.jcwhatever.nucleus.collections.ElementCounter;
import com.jcwhatever.nucleus.collections.ElementCounter.RemovalPolicy;
import com.jcwhatever.nucleus.collections.wrap.MultimapWrapper;
import com.jcwhatever.nucleus.collections.wrap.SyncStrategy;
import com.jcwhatever.nucleus.mixins.IDisposable;
import com.jcwhatever.nucleus.utils.CollectionUtils;
import com.jcwhatever.nucleus.utils.observer.ISubscriber;
import com.jcwhatever.nucleus.utils.observer.ISubscriberAgent;
import com.jcwhatever.nucleus.utils.observer.SubscriberAgent;
import java.util.Collection;
import java.util.Map.Entry;
import javax.annotation.Nullable;
/**
* A {@link com.google.common.collect.Multimap} of {@link ISubscriber} which automatically
* removes subscribers when they are disposed.
*
* <p>Assumes the subscriber is properly implemented and calls the {@link ISubscriberAgent#removeSubscriber} method
* of all {@link ISubscriberAgent} instances that are registered to it when it's disposed.</p>
*
* <p>The collection has its own internal agent which is used to track the subscribers in
* the collection. If an implementation wishes to add its own agent, 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 SubscriberMultimap<K, V
extends ISubscriber> extends MultimapWrapper<K, V> implements IDisposable {
private final MapAgent _mapAgent;
private final ElementCounter<ISubscriber> _counter = new ElementCounter<>(RemovalPolicy.REMOVE);
private transient boolean _isDisposed;
/**
* Constructor.
*
* <p>Uses a private synchronization object and subscriber.</p>
*/
public SubscriberMultimap() {
this(SyncStrategy.SYNC, null);
}
/**
* Constructor.
*
* @param strategy The synchronization object to use.
* @param agent The agent to use. Optional. A new one is created if null.
*/
protected SubscriberMultimap(SyncStrategy strategy, @Nullable ISubscriberAgent agent) {
super(strategy);
_mapAgent = new MapAgent(agent != null ? agent : new SubscriberAgent() {});
}
@Override
public boolean isDisposed() {
return _isDisposed;
}
@Override
public void dispose() {
if (isDisposed())
return;
synchronized (_sync) {
if (isDisposed())
return;
_mapAgent.dispose();
map().clear();
_isDisposed = true;
}
}
@Override
protected void onPut(K key, V value) {
if (isDisposed())
throw new RuntimeException("Cannot use a disposed SubscriberMultimap.");
registerSubscriber(value);
}
@Override
protected void onPutAll(K key, Iterable<? extends V> values) {
if (isDisposed())
throw new RuntimeException("Cannot use a disposed SubscriberMultimap.");
for (V value : values) {
registerSubscriber(value);
}
}
@Override
protected void onRemove(Object key, Object value) {
@SuppressWarnings("unchecked")
V agent = (V)value;
unregisterSubscriber(agent);
}
@Override
protected void onRemoveAll(Object key, Collection<V> values) {
for (V value : values) {
unregisterSubscriber(value);
}
}
@Override
protected void onClear(Collection<Entry<K, V>> entries) {
for (Entry<K, V> entry : entries) {
unregisterSubscriber(entry.getValue());
}
}
private void registerSubscriber(V subscriber) {
int count;
synchronized (_sync) {
_counter.add(subscriber);
count = _counter.count(subscriber);
}
if (count == 1) {
_mapAgent.addSubscriber(subscriber);
}
}
private void unregisterSubscriber(V subscriber) {
int count;
synchronized (_sync) {
_counter.subtract(subscriber);
count = _counter.count(subscriber);
}
if (count == 0) {
_mapAgent.safeUnregister(subscriber);
}
}
private class MapAgent extends CollectionAgent {
MapAgent(ISubscriberAgent agent) {
super(agent);
}
@Override
protected void removeFromCollection(ISubscriber subscriber) {
synchronized (_sync) {
//noinspection SuspiciousMethodCalls
CollectionUtils.removeValue(map(), subscriber);
}
}
}
}