Java example source code file (StringSelection.java)

This example Java source code file (StringSelection.java) is included in the alvinalexander.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Learn more about this Java project at its project page.

Java - Java tags/keywords

clipboardowner, dataflavor, ioexception, object, plain_text, string, stringreader, stringselection, transferable, unsupportedflavorexception

The StringSelection.java Java example source code

/*
 * Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package java.awt.datatransfer;

import java.io.*;


/**
 * A <code>Transferable which implements the capability required
 * to transfer a <code>String.
 *
 * This <code>Transferable properly supports
 * <code>DataFlavor.stringFlavor
 * and all equivalent flavors. Support for
 * <code>DataFlavor.plainTextFlavor
 * and all equivalent flavors is <b>deprecated. No other
 * <code>DataFlavors are supported.
 *
 * @see java.awt.datatransfer.DataFlavor#stringFlavor
 * @see java.awt.datatransfer.DataFlavor#plainTextFlavor
 */
public class StringSelection implements Transferable, ClipboardOwner {

    private static final int STRING = 0;
    private static final int PLAIN_TEXT = 1;

    private static final DataFlavor[] flavors = {
        DataFlavor.stringFlavor,
        DataFlavor.plainTextFlavor // deprecated
    };

    private String data;

    /**
     * Creates a <code>Transferable capable of transferring
     * the specified <code>String.
     */
    public StringSelection(String data) {
        this.data = data;
    }

    /**
     * Returns an array of flavors in which this <code>Transferable
     * can provide the data. <code>DataFlavor.stringFlavor
     * is properly supported.
     * Support for <code>DataFlavor.plainTextFlavor is
     * <b>deprecated.
     *
     * @return an array of length two, whose elements are <code>DataFlavor.
     *         stringFlavor</code> and DataFlavor.plainTextFlavor
     */
    public DataFlavor[] getTransferDataFlavors() {
        // returning flavors itself would allow client code to modify
        // our internal behavior
        return (DataFlavor[])flavors.clone();
    }

    /**
     * Returns whether the requested flavor is supported by this
     * <code>Transferable.
     *
     * @param flavor the requested flavor for the data
     * @return true if <code>flavor is equal to
     *   <code>DataFlavor.stringFlavor or
     *   <code>DataFlavor.plainTextFlavor; false if flavor
     *   is not one of the above flavors
     * @throws NullPointerException if flavor is <code>null
     */
    public boolean isDataFlavorSupported(DataFlavor flavor) {
        // JCK Test StringSelection0003: if 'flavor' is null, throw NPE
        for (int i = 0; i < flavors.length; i++) {
            if (flavor.equals(flavors[i])) {
                return true;
            }
        }
        return false;
    }

    /**
     * Returns the <code>Transferable's data in the requested
     * <code>DataFlavor if possible. If the desired flavor is
     * <code>DataFlavor.stringFlavor, or an equivalent flavor,
     * the <code>String representing the selection is
     * returned. If the desired flavor is
     * <code>DataFlavor.plainTextFlavor,
     * or an equivalent flavor, a <code>Reader is returned.
     * <b>Note: The behavior of this method for
     * <code>DataFlavor.plainTextFlavor
     * and equivalent <code>DataFlavors is inconsistent with the
     * definition of <code>DataFlavor.plainTextFlavor.
     *
     * @param flavor the requested flavor for the data
     * @return the data in the requested flavor, as outlined above
     * @throws UnsupportedFlavorException if the requested data flavor is
     *         not equivalent to either <code>DataFlavor.stringFlavor
     *         or <code>DataFlavor.plainTextFlavor
     * @throws IOException if an IOException occurs while retrieving the data.
     *         By default, StringSelection never throws this exception, but a
     *         subclass may.
     * @throws NullPointerException if flavor is <code>null
     * @see java.io.Reader
     */
    public Object getTransferData(DataFlavor flavor)
        throws UnsupportedFlavorException, IOException
    {
        // JCK Test StringSelection0007: if 'flavor' is null, throw NPE
        if (flavor.equals(flavors[STRING])) {
            return (Object)data;
        } else if (flavor.equals(flavors[PLAIN_TEXT])) {
            return new StringReader(data == null ? "" : data);
        } else {
            throw new UnsupportedFlavorException(flavor);
        }
    }

    public void lostOwnership(Clipboard clipboard, Transferable contents) {
    }
}