Removed DOCUMENT ME comments that were generated and applied source code
[utils] / support / general / src / main / java / org / wamblee / observer / Observable.java
index 820db38c8bb3241b61d3d3a12ab19585351ae4d4..219c51fcee04d8adcae19c249b0eaaa423b648f0 100644 (file)
@@ -1,34 +1,32 @@
 /*
  * 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<ObservableType, Event> {
-
     private static final Logger LOGGER = Logger.getLogger(Observable.class);
 
     /**
@@ -60,7 +58,7 @@ public class Observable<ObservableType, Event> {
      *            Object used for implementing notification of listeners.
      */
     public Observable(ObservableType aObservable,
-            ObserverNotifier<ObservableType, Event> aNotifier) {
+        ObserverNotifier<ObservableType, Event> aNotifier) {
         observable = aObservable;
         notifier = aNotifier;
         observers = new TreeMap<Long, Observer<ObservableType, Event>>();
@@ -76,8 +74,10 @@ public class Observable<ObservableType, Event> {
      */
     public synchronized long subscribe(Observer<ObservableType, Event> aObserver) {
         long subscription = counter++; // integer rage is so large it will
-                                        // never roll over.
+        // never roll over.
+
         observers.put(subscription, aObserver);
+
         return subscription;
     }
 
@@ -91,9 +91,10 @@ public class Observable<ObservableType, Event> {
      */
     public synchronized void unsubscribe(long aSubscription) {
         Object obj = observers.remove(aSubscription);
+
         if (obj == null) {
-            throw new IllegalArgumentException("Subscription '" + aSubscription
-                    + "'");
+            throw new IllegalArgumentException("Subscription '" +
+                aSubscription + "'");
         }
     }
 
@@ -117,9 +118,11 @@ public class Observable<ObservableType, Event> {
         // potential deadlock
         // situations.
         List<Observer<ObservableType, Event>> myObservers = new ArrayList<Observer<ObservableType, Event>>();
+
         synchronized (this) {
             myObservers.addAll(observers.values());
         }
+
         for (Observer<ObservableType, Event> observer : myObservers) {
             notifier.update(observer, observable, aEvent);
         }
@@ -134,7 +137,8 @@ public class Observable<ObservableType, Event> {
     protected void finalize() throws Throwable {
         if (observers.size() > 0) {
             LOGGER
-                    .error("Still observers registered at finalization of observer!");
+                .error("Still observers registered at finalization of observer!");
+
             for (Observer observer : observers.values()) {
                 LOGGER.error("  observer: " + observer);
             }
@@ -142,5 +146,4 @@ public class Observable<ObservableType, Event> {
 
         super.finalize();
     }
-
 }