1 /* 2 * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package java.awt.datatransfer; 27 28 import java.io.*; 29 30 31 /** 32 * A <code>Transferable</code> which implements the capability required 33 * to transfer a <code>String</code>. 34 * 35 * This <code>Transferable</code> properly supports 36 * <code>DataFlavor.stringFlavor</code> 37 * and all equivalent flavors. Support for 38 * <code>DataFlavor.plainTextFlavor</code> 39 * and all equivalent flavors is <b>deprecated</b>. No other 40 * <code>DataFlavor</code>s are supported. 41 * 42 * @see java.awt.datatransfer.DataFlavor#stringFlavor 43 * @see java.awt.datatransfer.DataFlavor#plainTextFlavor 44 */ 45 public class StringSelection implements Transferable, ClipboardOwner { 46 47 private static final int STRING = 0; 48 private static final int PLAIN_TEXT = 1; 49 50 private static final DataFlavor[] flavors = { 51 DataFlavor.stringFlavor, 52 DataFlavor.plainTextFlavor // deprecated 53 }; 54 55 private String data; 56 57 /** 58 * Creates a <code>Transferable</code> capable of transferring 59 * the specified <code>String</code>. 60 * @param data the string to be transferred 61 */ 62 public StringSelection(String data) { 63 this.data = data; 64 } 65 66 /** 67 * Returns an array of flavors in which this <code>Transferable</code> 68 * can provide the data. <code>DataFlavor.stringFlavor</code> 69 * is properly supported. 70 * Support for <code>DataFlavor.plainTextFlavor</code> is 71 * <b>deprecated</b>. 72 * 73 * @return an array of length two, whose elements are <code>DataFlavor. 74 * stringFlavor</code> and <code>DataFlavor.plainTextFlavor</code> 75 */ 76 public DataFlavor[] getTransferDataFlavors() { 77 // returning flavors itself would allow client code to modify 78 // our internal behavior 79 return (DataFlavor[])flavors.clone(); 80 } 81 82 /** 83 * Returns whether the requested flavor is supported by this 84 * <code>Transferable</code>. 85 * 86 * @param flavor the requested flavor for the data 87 * @return true if <code>flavor</code> is equal to 88 * <code>DataFlavor.stringFlavor</code> or 89 * <code>DataFlavor.plainTextFlavor</code>; false if <code>flavor</code> 90 * is not one of the above flavors 91 * @throws NullPointerException if flavor is <code>null</code> 92 */ 93 public boolean isDataFlavorSupported(DataFlavor flavor) { 94 // JCK Test StringSelection0003: if 'flavor' is null, throw NPE 95 for (int i = 0; i < flavors.length; i++) { 96 if (flavor.equals(flavors[i])) { 97 return true; 98 } 99 } 100 return false; 101 } 102 103 /** 104 * Returns the <code>Transferable</code>'s data in the requested 105 * <code>DataFlavor</code> if possible. If the desired flavor is 106 * <code>DataFlavor.stringFlavor</code>, or an equivalent flavor, 107 * the <code>String</code> representing the selection is 108 * returned. If the desired flavor is 109 * <code>DataFlavor.plainTextFlavor</code>, 110 * or an equivalent flavor, a <code>Reader</code> is returned. 111 * <b>Note:</b> The behavior of this method for 112 * <code>DataFlavor.plainTextFlavor</code> 113 * and equivalent <code>DataFlavor</code>s is inconsistent with the 114 * definition of <code>DataFlavor.plainTextFlavor</code>. 115 * 116 * @param flavor the requested flavor for the data 117 * @return the data in the requested flavor, as outlined above 118 * @throws UnsupportedFlavorException if the requested data flavor is 119 * not equivalent to either <code>DataFlavor.stringFlavor</code> 120 * or <code>DataFlavor.plainTextFlavor</code> 121 * @throws IOException if an IOException occurs while retrieving the data. 122 * By default, StringSelection never throws this exception, but a 123 * subclass may. 124 * @throws NullPointerException if flavor is <code>null</code> 125 * @see java.io.Reader 126 */ 127 public Object getTransferData(DataFlavor flavor) 128 throws UnsupportedFlavorException, IOException 129 { 130 // JCK Test StringSelection0007: if 'flavor' is null, throw NPE 131 if (flavor.equals(flavors[STRING])) { 132 return (Object)data; 133 } else if (flavor.equals(flavors[PLAIN_TEXT])) { 134 return new StringReader(data == null ? "" : data); 135 } else { 136 throw new UnsupportedFlavorException(flavor); 137 } 138 } 139 140 public void lostOwnership(Clipboard clipboard, Transferable contents) { 141 } 142 }