1/* 2 * Copyright (c) 1997, 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 26package java.awt.datatransfer; 27 28import java.util.Map; 29 30/** 31 * A two-way Map between "natives" (Strings), which correspond to 32 * platform-specific data formats, and "flavors" (DataFlavors), which correspond 33 * to platform-independent MIME types. FlavorMaps need not be symmetric, but 34 * typically are. 35 * 36 * @since 1.2 37 */ 38public interface FlavorMap { 39 40 /** 41 * Returns a {@code Map} of the specified {@code DataFlavor}s to their 42 * corresponding {@code String} native. The returned {@code Map} is a 43 * modifiable copy of this {@code FlavorMap}'s internal data. Client code is 44 * free to modify the {@code Map} without affecting this object. 45 * 46 * @param flavors an array of {@code DataFlavor}s which will be the key set 47 * of the returned {@code Map}. If {@code null} is specified, a 48 * mapping of all {@code DataFlavor}s currently known to this 49 * {@code FlavorMap} to their corresponding {@code String} natives 50 * will be returned. 51 * @return a {@code java.util.Map} of {@code DataFlavor}s to {@code String} 52 * natives 53 */ 54 Map<DataFlavor, String> getNativesForFlavors(DataFlavor[] flavors); 55 56 /** 57 * Returns a {@code Map} of the specified {@code String} natives to their 58 * corresponding {@code DataFlavor}. The returned {@code Map} is a 59 * modifiable copy of this {@code FlavorMap}'s internal data. Client code is 60 * free to modify the {@code Map} without affecting this object. 61 * 62 * @param natives an array of {@code String}s which will be the key set of 63 * the returned {@code Map}. If {@code null} is specified, a mapping 64 * of all {@code String} natives currently known to this 65 * {@code FlavorMap} to their corresponding {@code DataFlavor}s will 66 * be returned. 67 * @return a {@code java.util.Map} of {@code String} natives to 68 * {@code DataFlavor}s 69 */ 70 Map<String, DataFlavor> getFlavorsForNatives(String[] natives); 71} 72