01 /*
02 * Copyright 1996-2003 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 package java.awt.datatransfer;
27
28 import java.io.IOException;
29
30 /**
31 * Defines the interface for classes that can be used to provide data
32 * for a transfer operation.
33 * <p>
34 * For information on using data transfer with Swing, see
35 * <a href="http://java.sun.com/docs/books/tutorial/uiswing/misc/dnd.html">
36 * How to Use Drag and Drop and Data Transfer</a>,
37 * a section in <em>The Java Tutorial</em>, for more information.
38 *
39 * @version 1.20, 05/05/07
40 * @author Amy Fowler
41 */
42
43 public interface Transferable {
44
45 /**
46 * Returns an array of DataFlavor objects indicating the flavors the data
47 * can be provided in. The array should be ordered according to preference
48 * for providing the data (from most richly descriptive to least descriptive).
49 * @return an array of data flavors in which this data can be transferred
50 */
51 public DataFlavor[] getTransferDataFlavors();
52
53 /**
54 * Returns whether or not the specified data flavor is supported for
55 * this object.
56 * @param flavor the requested flavor for the data
57 * @return boolean indicating whether or not the data flavor is supported
58 */
59 public boolean isDataFlavorSupported(DataFlavor flavor);
60
61 /**
62 * Returns an object which represents the data to be transferred. The class
63 * of the object returned is defined by the representation class of the flavor.
64 *
65 * @param flavor the requested flavor for the data
66 * @see DataFlavor#getRepresentationClass
67 * @exception IOException if the data is no longer available
68 * in the requested flavor.
69 * @exception UnsupportedFlavorException if the requested data flavor is
70 * not supported.
71 */
72 public Object getTransferData(DataFlavor flavor)
73 throws UnsupportedFlavorException, IOException;
74
75 }
|