jdk/src/java.desktop/share/classes/java/awt/ActiveEvent.java
author chegar
Sun, 17 Aug 2014 15:54:13 +0100
changeset 25859 3317bb8137f4
parent 5506 jdk/src/share/classes/java/awt/ActiveEvent.java@202f599c92aa
child 35667 ed476aba94de
permissions -rw-r--r--
8054834: Modular Source Code Reviewed-by: alanb, chegar, ihse, mduigou Contributed-by: alan.bateman@oracle.com, alex.buckley@oracle.com, chris.hegarty@oracle.com, erik.joelsson@oracle.com, jonathan.gibbons@oracle.com, karen.kinnear@oracle.com, magnus.ihse.bursie@oracle.com, mandy.chung@oracle.com, mark.reinhold@oracle.com, paul.sandoz@oracle.com
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     2
 * Copyright (c) 1997, 2002, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package java.awt;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
 * An interface for events that know how to dispatch themselves.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
 * By implementing this interface an event can be placed upon the event
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
 * queue and its <code>dispatch()</code> method will be called when the event
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 * is dispatched, using the <code>EventDispatchThread</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * This is a very useful mechanism for avoiding deadlocks. If
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * a thread is executing in a critical section (i.e., it has entered
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * one or more monitors), calling other synchronized code may
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * cause deadlocks. To avoid the potential deadlocks, an
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 * <code>ActiveEvent</code> can be created to run the second section of
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * code at later time. If there is contention on the monitor,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * the second thread will simply block until the first thread
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 * has finished its work and exited its monitors.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 * <p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
 * For security reasons, it is often desirable to use an <code>ActiveEvent</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 * to avoid calling untrusted code from a critical thread. For
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
 * instance, peer implementations can use this facility to avoid
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
 * making calls into user code from a system thread. Doing so avoids
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
 * potential deadlocks and denial-of-service attacks.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
 * @author  Timothy Prinzing
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
 * @since   1.2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
public interface ActiveEvent {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
     * Dispatch the event to its target, listeners of the events source,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
     * or do whatever it is this event is supposed to do.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
    public void dispatch();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
}