ClipboardHelpers.java

/*
Copyright 2011-2016 Google Inc. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package com.google.security.zynamics.zylib.general;

import com.google.common.base.Preconditions;

import java.awt.Toolkit;
import java.awt.datatransfer.Clipboard;
import java.awt.datatransfer.ClipboardOwner;
import java.awt.datatransfer.DataFlavor;
import java.awt.datatransfer.StringSelection;
import java.awt.datatransfer.Transferable;
import java.awt.datatransfer.UnsupportedFlavorException;
import java.io.IOException;

/**
 * This class provides quick-access functions to the system clipboard. These functions can be used
 * to quickly store data to or retrieve data from the system clipboard.
 */
public final class ClipboardHelpers {
  /**
   * Copies a string to the system clipboard.
   *
   * @param string The string to be copied to the system clipboard.
   */
  public static void copyToClipboard(final String string) {
    Preconditions.checkNotNull(string, "Error: String argument can not be null");

    final Clipboard clipboard = Toolkit.getDefaultToolkit().getSystemClipboard();

    clipboard.setContents(new StringSelection(string), new ClipboardOwner() {
      @Override
      public void lostOwnership(final Clipboard clipboard, final Transferable contents) {}
    });
  }

  /**
   * Returns the string that is currently stored in the system clipboard.
   *
   * @return The string from the system clipboard or null if there is no string currently stored in
   *         the clipboard.
   */
  public static String getClipboardString() {

    final Clipboard clipboard = Toolkit.getDefaultToolkit().getSystemClipboard();
    final Transferable contents = clipboard.getContents(null);

    final boolean hasTransferableText =
        (contents != null) && contents.isDataFlavorSupported(DataFlavor.stringFlavor);
    if (!hasTransferableText) {
      return null;
    }

    try {
      return (String) contents.getTransferData(DataFlavor.stringFlavor);
    } catch (UnsupportedFlavorException | IOException ex) {
      // Eat, cannot happen as we're checking above
    }

    return null;
  }
}