1 /*

     2  * Copyright (c) 1996, 2017, 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 /**

    29  * Defines the interface for classes that will provide data to a clipboard. An

    30  * instance of this interface becomes the owner of the contents of a clipboard

    31  * (clipboard owner) if it is passed as an argument to

    32  * {@link Clipboard#setContents} method of the clipboard and this method returns

    33  * successfully. The instance remains the clipboard owner until another

    34  * application or another object within this application asserts ownership of

    35  * this clipboard.

    36  *

    37  * @author Amy Fowler

    38  * @see Clipboard

    39  * @since 1.1

    40  */

    41 public interface ClipboardOwner {

    42 

    43     /**

    44      * Notifies this object that it is no longer the clipboard owner. This

    45      * method will be called when another application or another object within

    46      * this application asserts ownership of the clipboard.

    47      *

    48      * @param  clipboard the clipboard that is no longer owned

    49      * @param  contents the contents which this owner had placed on the

    50      *         {@code clipboard}

    51      */

    52     public void lostOwnership(Clipboard clipboard, Transferable contents);

    53 }