001/* Transferable.java -- Data transfer source
002   Copyright (C) 1999, 2002, 2005  Free Software Foundation, Inc.
003
004This file is part of GNU Classpath.
005
006GNU Classpath is free software; you can redistribute it and/or modify
007it under the terms of the GNU General Public License as published by
008the Free Software Foundation; either version 2, or (at your option)
009any later version.
010
011GNU Classpath is distributed in the hope that it will be useful, but
012WITHOUT ANY WARRANTY; without even the implied warranty of
013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
014General Public License for more details.
015
016You should have received a copy of the GNU General Public License
017along with GNU Classpath; see the file COPYING.  If not, write to the
018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
01902110-1301 USA.
020
021Linking this library statically or dynamically with other modules is
022making a combined work based on this library.  Thus, the terms and
023conditions of the GNU General Public License cover the whole
024combination.
025
026As a special exception, the copyright holders of this library give you
027permission to link this library with independent modules to produce an
028executable, regardless of the license terms of these independent
029modules, and to copy and distribute the resulting executable under
030terms of your choice, provided that you also meet, for each linked
031independent module, the terms and conditions of the license of that
032module.  An independent module is a module which is not derived from
033or based on this library.  If you modify this library, you may extend
034this exception to your version of the library, but you are not
035obligated to do so.  If you do not wish to do so, delete this
036exception statement from your version. */
037
038
039package java.awt.datatransfer;
040
041import 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 */
050public 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