rt/emul/compact/src/main/java/java/util/EventListenerProxy.java
author Jaroslav Tulach <jaroslav.tulach@apidesign.org>
Tue, 26 Feb 2013 16:54:16 +0100
changeset 772 d382dacfd73f
parent 601 emul/compact/src/main/java/java/util/EventListenerProxy.java@5198affdb915
permissions -rw-r--r--
Moving modules around so the runtime is under one master pom and can be built without building other modules that are in the repository
jaroslav@601
     1
/*
jaroslav@601
     2
 * Copyright (c) 2000, 2004, Oracle and/or its affiliates. All rights reserved.
jaroslav@601
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
jaroslav@601
     4
 *
jaroslav@601
     5
 * This code is free software; you can redistribute it and/or modify it
jaroslav@601
     6
 * under the terms of the GNU General Public License version 2 only, as
jaroslav@601
     7
 * published by the Free Software Foundation.  Oracle designates this
jaroslav@601
     8
 * particular file as subject to the "Classpath" exception as provided
jaroslav@601
     9
 * by Oracle in the LICENSE file that accompanied this code.
jaroslav@601
    10
 *
jaroslav@601
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
jaroslav@601
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
jaroslav@601
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
jaroslav@601
    14
 * version 2 for more details (a copy is included in the LICENSE file that
jaroslav@601
    15
 * accompanied this code).
jaroslav@601
    16
 *
jaroslav@601
    17
 * You should have received a copy of the GNU General Public License version
jaroslav@601
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
jaroslav@601
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
jaroslav@601
    20
 *
jaroslav@601
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
jaroslav@601
    22
 * or visit www.oracle.com if you need additional information or have any
jaroslav@601
    23
 * questions.
jaroslav@601
    24
 */
jaroslav@601
    25
jaroslav@601
    26
package java.util;
jaroslav@601
    27
jaroslav@601
    28
/**
jaroslav@601
    29
 * An abstract wrapper class for an {@code EventListener} class
jaroslav@601
    30
 * which associates a set of additional parameters with the listener.
jaroslav@601
    31
 * Subclasses must provide the storage and accessor methods
jaroslav@601
    32
 * for the additional arguments or parameters.
jaroslav@601
    33
 * <p>
jaroslav@601
    34
 * For example, a bean which supports named properties
jaroslav@601
    35
 * would have a two argument method signature for adding
jaroslav@601
    36
 * a {@code PropertyChangeListener} for a property:
jaroslav@601
    37
 * <pre>
jaroslav@601
    38
 * public void addPropertyChangeListener(String propertyName,
jaroslav@601
    39
 *                                       PropertyChangeListener listener)
jaroslav@601
    40
 * </pre>
jaroslav@601
    41
 * If the bean also implemented the zero argument get listener method:
jaroslav@601
    42
 * <pre>
jaroslav@601
    43
 * public PropertyChangeListener[] getPropertyChangeListeners()
jaroslav@601
    44
 * </pre>
jaroslav@601
    45
 * then the array may contain inner {@code PropertyChangeListeners}
jaroslav@601
    46
 * which are also {@code PropertyChangeListenerProxy} objects.
jaroslav@601
    47
 * <p>
jaroslav@601
    48
 * If the calling method is interested in retrieving the named property
jaroslav@601
    49
 * then it would have to test the element to see if it is a proxy class.
jaroslav@601
    50
 *
jaroslav@601
    51
 * @since 1.4
jaroslav@601
    52
 */
jaroslav@601
    53
public abstract class EventListenerProxy<T extends EventListener>
jaroslav@601
    54
        implements EventListener {
jaroslav@601
    55
jaroslav@601
    56
    private final T listener;
jaroslav@601
    57
jaroslav@601
    58
    /**
jaroslav@601
    59
     * Creates a proxy for the specified listener.
jaroslav@601
    60
     *
jaroslav@601
    61
     * @param listener  the listener object
jaroslav@601
    62
     */
jaroslav@601
    63
    public EventListenerProxy(T listener) {
jaroslav@601
    64
        this.listener = listener;
jaroslav@601
    65
    }
jaroslav@601
    66
jaroslav@601
    67
    /**
jaroslav@601
    68
     * Returns the listener associated with the proxy.
jaroslav@601
    69
     *
jaroslav@601
    70
     * @return  the listener associated with the proxy
jaroslav@601
    71
     */
jaroslav@601
    72
    public T getListener() {
jaroslav@601
    73
        return this.listener;
jaroslav@601
    74
    }
jaroslav@601
    75
}