X-Git-Url: http://wamblee.org/gitweb/?a=blobdiff_plain;f=support%2Fgeneral%2Fsrc%2Fmain%2Fjava%2Forg%2Fwamblee%2Fobserver%2FObservable.java;h=096b0600043f726d9bdc493f83d3aacbe2e19d78;hb=ddd261f331280640c5b53c7128230b629ebcd268;hp=2980afafd33dbc63a0a7416e6aed4ca7cb2396c9;hpb=32a62ca2c752e33a7873ac868a7a1f289caedcd4;p=utils diff --git a/support/general/src/main/java/org/wamblee/observer/Observable.java b/support/general/src/main/java/org/wamblee/observer/Observable.java index 2980afaf..096b0600 100644 --- a/support/general/src/main/java/org/wamblee/observer/Observable.java +++ b/support/general/src/main/java/org/wamblee/observer/Observable.java @@ -1,114 +1,117 @@ /* * Copyright 2005 the original author or authors. - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ - package org.wamblee.observer; -import java.util.List; +import org.apache.log4j.Logger; + import java.util.ArrayList; +import java.util.List; import java.util.Map; import java.util.TreeMap; -import org.apache.log4j.Logger; /** * Implements subscription and notification logic for an observer pattern. This * class is thread safe. */ public class Observable { - private static final Logger LOGGER = Logger.getLogger(Observable.class); /** * Observable. */ - private ObservableType _observable; + private ObservableType observable; /** * Used to notify observers. */ - private ObserverNotifier _notifier; + private ObserverNotifier notifier; /** * Map of subscription to observer. */ - private Map> _observers; + private Map> observers; /** * Counter for subscriptions. Holds the next subscription. */ - private long _counter; + private long counter; /** * Constructs the observable. - * + * * @param aObservable * Observable this instance is used for. * @param aNotifier * Object used for implementing notification of listeners. */ public Observable(ObservableType aObservable, - ObserverNotifier aNotifier) { - _observable = aObservable; - _notifier = aNotifier; - _observers = new TreeMap>(); - _counter = 0; + ObserverNotifier aNotifier) { + observable = aObservable; + notifier = aNotifier; + observers = new TreeMap>(); + counter = 0; } /** * Subscribe an obvers. - * + * * @param aObserver * Observer to subscribe. * @return Event Event to send. */ - public synchronized long subscribe(Observer aObserver) { - long subscription = _counter++; // integer rage is so large it will - // never roll over. - _observers.put(subscription, aObserver); + public synchronized long subscribe( + Observer aObserver) { + long subscription = counter++; // integer rage is so large it will + // never roll over. + + observers.put(subscription, aObserver); + return subscription; } /** * Unsubscribe an observer. - * + * * @param aSubscription * Subscription which is used * @throws IllegalArgumentException * In case the subscription is not known. */ public synchronized void unsubscribe(long aSubscription) { - Object obj = _observers.remove(aSubscription); + Object obj = observers.remove(aSubscription); + if (obj == null) { - throw new IllegalArgumentException("Subscription '" + aSubscription - + "'"); + throw new IllegalArgumentException("Subscription '" + + aSubscription + "'"); } } /** * Gets the number of subscribed observers. - * + * * @return Number of subscribed observers. */ public int getObserverCount() { - return _observers.size(); + return observers.size(); } /** * Notifies all subscribed observers. - * + * * @param aEvent * Event to send. */ @@ -116,31 +119,33 @@ public class Observable { // Make sure we do the notification while not holding the lock to avoid // potential deadlock // situations. - List> observers = new ArrayList>(); + List> myObservers = new ArrayList>(); + synchronized (this) { - observers.addAll(_observers.values()); + myObservers.addAll(observers.values()); } - for (Observer observer : observers) { - _notifier.update(observer, _observable, aEvent); + + for (Observer observer : myObservers) { + notifier.update(observer, observable, aEvent); } } /* * (non-Javadoc) - * + * * @see java.lang.Object#finalize() */ @Override protected void finalize() throws Throwable { - if (_observers.size() > 0) { - LOGGER - .error("Still observers registered at finalization of observer!"); - for (Observer observer : _observers.values()) { + if (observers.size() > 0) { + LOGGER.error( + "Still observers registered at finalization of observer!"); + + for (Observer observer : observers.values()) { LOGGER.error(" observer: " + observer); } } super.finalize(); } - }