001 /*
002 * Copyright 1996-2006 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package java.awt.datatransfer;
027
028 import java.io.*;
029
030 /**
031 * A <code>Transferable</code> which implements the capability required
032 * to transfer a <code>String</code>.
033 *
034 * This <code>Transferable</code> properly supports
035 * <code>DataFlavor.stringFlavor</code>
036 * and all equivalent flavors. Support for
037 * <code>DataFlavor.plainTextFlavor</code>
038 * and all equivalent flavors is <b>deprecated</b>. No other
039 * <code>DataFlavor</code>s are supported.
040 *
041 * @see java.awt.datatransfer.DataFlavor#stringFlavor
042 * @see java.awt.datatransfer.DataFlavor#plainTextFlavor
043 */
044 public class StringSelection implements Transferable, ClipboardOwner {
045
046 private static final int STRING = 0;
047 private static final int PLAIN_TEXT = 1;
048
049 private static final DataFlavor[] flavors = {
050 DataFlavor.stringFlavor, DataFlavor.plainTextFlavor // deprecated
051 };
052
053 private String data;
054
055 /**
056 * Creates a <code>Transferable</code> capable of transferring
057 * the specified <code>String</code>.
058 */
059 public StringSelection(String data) {
060 this .data = data;
061 }
062
063 /**
064 * Returns an array of flavors in which this <code>Transferable</code>
065 * can provide the data. <code>DataFlavor.stringFlavor</code>
066 * is properly supported.
067 * Support for <code>DataFlavor.plainTextFlavor</code> is
068 * <b>deprecated</b>.
069 *
070 * @return an array of length two, whose elements are <code>DataFlavor.
071 * stringFlavor</code> and <code>DataFlavor.plainTextFlavor</code>
072 */
073 public DataFlavor[] getTransferDataFlavors() {
074 // returning flavors itself would allow client code to modify
075 // our internal behavior
076 return (DataFlavor[]) flavors.clone();
077 }
078
079 /**
080 * Returns whether the requested flavor is supported by this
081 * <code>Transferable</code>.
082 *
083 * @param flavor the requested flavor for the data
084 * @return true if <code>flavor</code> is equal to
085 * <code>DataFlavor.stringFlavor</code> or
086 * <code>DataFlavor.plainTextFlavor</code>; false if <code>flavor</code>
087 * is not one of the above flavors
088 * @throws NullPointerException if flavor is <code>null</code>
089 */
090 public boolean isDataFlavorSupported(DataFlavor flavor) {
091 // JCK Test StringSelection0003: if 'flavor' is null, throw NPE
092 for (int i = 0; i < flavors.length; i++) {
093 if (flavor.equals(flavors[i])) {
094 return true;
095 }
096 }
097 return false;
098 }
099
100 /**
101 * Returns the <code>Transferable</code>'s data in the requested
102 * <code>DataFlavor</code> if possible. If the desired flavor is
103 * <code>DataFlavor.stringFlavor</code>, or an equivalent flavor,
104 * the <code>String</code> representing the selection is
105 * returned. If the desired flavor is
106 * <code>DataFlavor.plainTextFlavor</code>,
107 * or an equivalent flavor, a <code>Reader</code> is returned.
108 * <b>Note:</b> The behavior of this method for
109 * <code>DataFlavor.plainTextFlavor</code>
110 * and equivalent <code>DataFlavor</code>s is inconsistent with the
111 * definition of <code>DataFlavor.plainTextFlavor</code>.
112 *
113 * @param flavor the requested flavor for the data
114 * @return the data in the requested flavor, as outlined above
115 * @throws UnsupportedFlavorException if the requested data flavor is
116 * not equivalent to either <code>DataFlavor.stringFlavor</code>
117 * or <code>DataFlavor.plainTextFlavor</code>
118 * @throws IOException if an IOException occurs while retrieving the data.
119 * By default, StringSelection never throws this exception, but a
120 * subclass may.
121 * @throws NullPointerException if flavor is <code>null</code>
122 * @see java.io.Reader
123 */
124 public Object getTransferData(DataFlavor flavor)
125 throws UnsupportedFlavorException, IOException {
126 // JCK Test StringSelection0007: if 'flavor' is null, throw NPE
127 if (flavor.equals(flavors[STRING])) {
128 return (Object) data;
129 } else if (flavor.equals(flavors[PLAIN_TEXT])) {
130 return new StringReader(data == null ? "" : data);
131 } else {
132 throw new UnsupportedFlavorException(flavor);
133 }
134 }
135
136 public void lostOwnership(Clipboard clipboard, Transferable contents) {
137 }
138 }
|