eu.ocathain.awt.datatransfer.FlavorTable 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) 2000, 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 eu.ocathain.awt.datatransfer.DataFlavor;
import java.util.List;


/**
 * A FlavorMap which relaxes the traditional 1-to-1 restriction of a Map. A
 * flavor is permitted to map to any number of natives, and likewise a native
 * is permitted to map to any number of flavors. FlavorTables need not be
 * symmetric, but typically are.
 *
 * @author David Mendenhall
 *
 * @since 1.4
 */
public interface FlavorTable extends eu.ocathain.awt.datatransfer.FlavorMap {

    /**
     * Returns a List of String natives to which the
     * specified DataFlavor corresponds. The List
     * will be sorted from best native to worst. That is, the first native will
     * best reflect data in the specified flavor to the underlying native
     * platform. The returned List is a modifiable copy of this
     * FlavorTable's internal data. Client code is free to modify
     * the List without affecting this object.
     *
     * @param flav the DataFlavor whose corresponding natives
     *        should be returned. If null is specified, all
     *        natives currently known to this FlavorTable are
     *        returned in a non-deterministic order.
     * @return a java.util.List of java.lang.String
     *         objects which are platform-specific representations of platform-
     *         specific data formats
     */
    List getNativesForFlavor(eu.ocathain.awt.datatransfer.DataFlavor flav);

    /**
     * Returns a List of DataFlavors to which the
     * specified String corresponds. The List will be
     * sorted from best DataFlavor to worst. That is, the first
     * DataFlavor will best reflect data in the specified
     * native to a Java application. The returned List is a
     * modifiable copy of this FlavorTable's internal data.
     * Client code is free to modify the List without affecting
     * this object.
     *
     * @param nat the native whose corresponding DataFlavors
     *        should be returned. If null is specified, all
     *        DataFlavors currently known to this
     *        FlavorTable are returned in a non-deterministic
     *        order.
     * @return a java.util.List of DataFlavor
     *         objects into which platform-specific data in the specified,
     *         platform-specific native can be translated
     */
    List getFlavorsForNative(String nat);
}