eu.ocathain.awt.datatransfer.FlavorMap Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of activation Show documentation

A minimal port of Java Activation Framework with the AWT dependencies removed. Exists purely to allow the Android port of JavaMail to work.

The newest version!

/*
 * Copyright (c) 1997, 2004, 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 eu.ocathain.awt.datatransfer;

import eu.ocathain.awt.datatransfer.*;
import java.util.Map;


/**
 * A two-way Map between "natives" (Strings), which correspond to platform-
 * specfic data formats, and "flavors" (DataFlavors), which corerspond to
 * platform-independent MIME types. FlavorMaps need not be symmetric, but
 * typically are.
 *
 *
 * @since 1.2
 */
public interface FlavorMap {

    /**
     * Returns a Map of the specified DataFlavors to
     * their corresponding String native. The returned
     * Map is a modifiable copy of this FlavorMap's
     * internal data. Client code is free to modify the Map
     * without affecting this object.
     *
     * @param flavors an array of DataFlavors which will be the
     *        key set of the returned Map. If null is
     *        specified, a mapping of all DataFlavors currently
     *        known to this FlavorMap to their corresponding
     *        String natives will be returned.
     * @return a java.util.Map of DataFlavors to
     *         String natives
     */
    Map getNativesForFlavors(eu.ocathain.awt.datatransfer.DataFlavor[] flavors);

    /**
     * Returns a Map of the specified String natives
     * to their corresponding DataFlavor. The returned
     * Map is a modifiable copy of this FlavorMap's
     * internal data. Client code is free to modify the Map
     * without affecting this object.
     *
     * @param natives an array of Strings which will be the
     *        key set of the returned Map. If null is
     *        specified, a mapping of all String natives currently
     *        known to this FlavorMap to their corresponding
     *        DataFlavors will be returned.
     * @return a java.util.Map of String natives to
     *         DataFlavors
     */
    Map getFlavorsForNatives(String[] natives);
}