001 /* Transferable.java -- Data transfer source
002 Copyright (C) 1999, 2002, 2005 Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038
039 package java.awt.datatransfer;
040
041 import java.io.IOException;
042
043 /**
044 * This interface is implemented by classes that can transfer data.
045 *
046 * @author Aaron M. Renn (arenn@urbanophile.com)
047 * @since 1.1
048 * @status updated to 1.4
049 */
050 public interface Transferable
051 {
052 /**
053 * This method returns a list of available data flavors for the data being
054 * transferred. The array returned will be sorted from most preferred
055 * flavor at the beginning to least preferred at the end.
056 *
057 * @return adA list of data flavors for this data
058 */
059 DataFlavor[] getTransferDataFlavors();
060
061 /**
062 * Tests whether or not this data can be delivered in the specified data
063 * flavor.
064 *
065 * @param flavor the data flavor to test
066 * @return true if the data flavor is supported
067 */
068 boolean isDataFlavorSupported(DataFlavor flavor);
069
070 /**
071 * Returns the data in the specified <code>DataFlavor</code>.
072 *
073 * @param flavor the data flavor to return
074 * @return the data in the appropriate flavor
075 * @throws UnsupportedFlavorException if the flavor is not supported
076 * @throws IOException if the data is not available
077 * @see DataFlavor#getRepresentationClass
078 */
079 Object getTransferData(DataFlavor flavor)
080 throws UnsupportedFlavorException, IOException;
081
082 } // interface Transferable