FlavorListener.java revision 11425:a441d42065cf
1/*
2 * Copyright (c) 2003, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25package java.awt.datatransfer;
26
27import java.util.EventListener;
28
29
30/**
31 * Defines an object which listens for {@link FlavorEvent}s.
32 *
33 * @author Alexander Gerasimov
34 * @since 1.5
35 */
36public interface FlavorListener extends EventListener {
37    /**
38     * Invoked when the target {@link Clipboard} of the listener
39     * has changed its available {@link DataFlavor}s.
40     * <p>
41     * Some notifications may be redundant &#8212; they are not
42     * caused by a change of the set of DataFlavors available
43     * on the clipboard.
44     * For example, if the clipboard subsystem supposes that
45     * the system clipboard's contents has been changed but it
46     * can't ascertain whether its DataFlavors have been changed
47     * because of some exceptional condition when accessing the
48     * clipboard, the notification is sent to ensure from omitting
49     * a significant notification. Ordinarily, those redundant
50     * notifications should be occasional.
51     *
52     * @param e  a <code>FlavorEvent</code> object
53     */
54    void flavorsChanged(FlavorEvent e);
55}
56