ListenerList.java

  1. /*
  2.  * Licensed to the Apache Software Foundation (ASF) under one or more
  3.  * contributor license agreements.  See the NOTICE file distributed with
  4.  * this work for additional information regarding copyright ownership.
  5.  * The ASF licenses this file to You under the Apache License, Version 2.0
  6.  * (the "License"); you may not use this file except in compliance with
  7.  * the License.  You may obtain a copy of the License at
  8.  *
  9.  *      http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */

  17. package org.apache.commons.net.util;

  18. import java.io.ObjectInputStream;
  19. import java.io.ObjectOutputStream;
  20. import java.io.Serializable;
  21. import java.util.EventListener;
  22. import java.util.Iterator;
  23. import java.util.concurrent.CopyOnWriteArrayList;

  24. /**
  25.  */
  26. public class ListenerList implements Serializable, Iterable<EventListener> {

  27.     private static final long serialVersionUID = -1934227607974228213L;

  28.     private final CopyOnWriteArrayList<EventListener> listeners;

  29.     public ListenerList() {
  30.         listeners = new CopyOnWriteArrayList<>();
  31.     }

  32.     public void addListener(final EventListener listener) {
  33.         listeners.add(listener);
  34.     }

  35.     public int getListenerCount() {
  36.         return listeners.size();
  37.     }

  38.     /**
  39.      * Return an {@link Iterator} for the {@link EventListener} instances.
  40.      *
  41.      * @return an {@link Iterator} for the {@link EventListener} instances
  42.      * @since 2.0 TODO Check that this is a good defensive strategy
  43.      */
  44.     @Override
  45.     public Iterator<EventListener> iterator() {
  46.         return listeners.iterator();
  47.     }

  48.     private void readObject(final ObjectInputStream in) {
  49.         throw new UnsupportedOperationException("Serialization is not supported");
  50.     }

  51.     /*
  52.      * Serialization is unnecessary for this class. Reject attempts to do so until such time as the Serializable attribute can be dropped.
  53.      */

  54.     public void removeListener(final EventListener listener) {
  55.         listeners.remove(listener);
  56.     }

  57.     private void writeObject(final ObjectOutputStream out) {
  58.         throw new UnsupportedOperationException("Serialization is not supported");
  59.     }

  60. }