Source for java.awt.datatransfer.Transferable

   1: /* Transferable.java -- Data transfer source
   2:    Copyright (C) 1999, 2002, 2005  Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package java.awt.datatransfer;
  40: 
  41: import java.io.IOException;
  42: 
  43: /**
  44:  * This interface is implemented by classes that can transfer data.
  45:  *
  46:  * @author Aaron M. Renn (arenn@urbanophile.com)
  47:  * @since 1.1
  48:  * @status updated to 1.4
  49:  */
  50: public interface Transferable
  51: {
  52:   /**
  53:    * This method returns a list of available data flavors for the data being
  54:    * transferred.  The array returned will be sorted from most preferred
  55:    * flavor at the beginning to least preferred at the end.
  56:    *
  57:    * @return adA list of data flavors for this data
  58:    */
  59:   DataFlavor[] getTransferDataFlavors();
  60: 
  61:   /**
  62:    * Tests whether or not this data can be delivered in the specified data
  63:    * flavor.
  64:    *
  65:    * @param flavor the data flavor to test
  66:    * @return true if the data flavor is supported
  67:    */
  68:   boolean isDataFlavorSupported(DataFlavor flavor);
  69: 
  70:   /**
  71:    * Returns the data in the specified <code>DataFlavor</code>.
  72:    *
  73:    * @param flavor the data flavor to return
  74:    * @return the data in the appropriate flavor
  75:    * @throws UnsupportedFlavorException if the flavor is not supported
  76:    * @throws IOException if the data is not available
  77:    * @see DataFlavor#getRepresentationClass
  78:    */
  79:   Object getTransferData(DataFlavor flavor)
  80:     throws UnsupportedFlavorException, IOException;
  81: 
  82: } // interface Transferable