FlavorMap
, FlavorTable
public final class SystemFlavorMap extends Object implements FlavorMap, FlavorTable
Modifier and Type | Method | Description |
---|---|---|
void |
addFlavorForUnencodedNative |
Adds a mapping from a single String native to a single DataFlavor . |
void |
addUnencodedNativeForFlavor |
Adds a mapping from the specified DataFlavor (and all DataFlavor s equal to the specified DataFlavor ) to the specified String native. |
static DataFlavor |
decodeDataFlavor |
Decodes a String native for use as a DataFlavor . |
static String |
decodeJavaMIMEType |
Decodes a String native for use as a Java MIME type. |
static String |
encodeDataFlavor |
Encodes a DataFlavor for use as a String native. |
static String |
encodeJavaMIMEType |
Encodes a MIME type for use as a String native. |
static FlavorMap |
getDefaultFlavorMap() |
Returns the default FlavorMap for this thread's ClassLoader. |
List |
getFlavorsForNative |
Returns a List of DataFlavor s to which the specified String native can be translated by the data transfer subsystem. |
Map |
getFlavorsForNatives |
Returns a Map of the specified String natives to their most preferred DataFlavor . |
List |
getNativesForFlavor |
Returns a List of String natives to which the specified DataFlavor can be translated by the data transfer subsystem. |
Map |
getNativesForFlavors |
Returns a Map of the specified DataFlavor s to their most preferred String native. |
static boolean |
isJavaMIMEType |
Returns whether the specified String is an encoded Java MIME type. |
void |
setFlavorsForNative |
Discards the current mappings for the specified String native, and creates new mappings to the specified DataFlavor s. |
void |
setNativesForFlavor |
Discards the current mappings for the specified DataFlavor and all DataFlavor s equal to the specified DataFlavor , and creates new mappings to the specified String natives. |
public static FlavorMap getDefaultFlavorMap()
public List<String> getNativesForFlavor(DataFlavor flav)
List
of String
natives to which the specified DataFlavor
can be translated by the data transfer subsystem. 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. If the specified DataFlavor
is previously unknown to the data transfer subsystem and the data transfer subsystem is unable to translate this DataFlavor
to any existing native, then invoking this method will establish a mapping in both directions between the specified DataFlavor
and an encoded version of its MIME type as its native.
getNativesForFlavor
in interface FlavorTable
flav
- the DataFlavor
whose corresponding natives should be returned. If null
is specified, all natives currently known to the data transfer subsystem are returned in a non-deterministic order.java.util.List
of java.lang.String
objects which are platform-specific representations of platform-specific data formatspublic List<DataFlavor> getFlavorsForNative(String nat)
List
of DataFlavor
s to which the specified String
native can be translated by the data transfer subsystem. 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. If the specified native is previously unknown to the data transfer subsystem, and that native has been properly encoded, then invoking this method will establish a mapping in both directions between the specified native and a DataFlavor
whose MIME type is a decoded version of the native.
If the specified native is not a properly encoded native and the mappings for this native have not been altered with setFlavorsForNative
, then the contents of the List
is platform dependent, but null
cannot be returned.
getFlavorsForNative
in interface FlavorTable
nat
- the native whose corresponding DataFlavor
s should be returned. If null
is specified, all DataFlavor
s currently known to the data transfer subsystem are returned in a non-deterministic order.java.util.List
of DataFlavor
objects into which platform-specific data in the specified, platform-specific native can be translatedpublic Map<DataFlavor,String> getNativesForFlavors(DataFlavor[] flavors)
Map
of the specified DataFlavor
s to their most preferred String
native. Each native value will be the same as the first native in the List returned by getNativesForFlavor
for the specified flavor. If a specified DataFlavor
is previously unknown to the data transfer subsystem, then invoking this method will establish a mapping in both directions between the specified DataFlavor
and an encoded version of its MIME type as its native.
getNativesForFlavors
in interface FlavorMap
flavors
- an array of DataFlavor
s which will be the key set of the returned Map
. If null
is specified, a mapping of all DataFlavor
s known to the data transfer subsystem to their most preferred String
natives will be returned.java.util.Map
of DataFlavor
s to String
nativespublic Map<String,DataFlavor> getFlavorsForNatives(String[] natives)
Map
of the specified String
natives to their most preferred DataFlavor
. Each DataFlavor
value will be the same as the first DataFlavor
in the List returned by getFlavorsForNative
for the specified native. If a specified native is previously unknown to the data transfer subsystem, and that native has been properly encoded, then invoking this method will establish a mapping in both directions between the specified native and a DataFlavor
whose MIME type is a decoded version of the native.
getFlavorsForNatives
in interface FlavorMap
natives
- an array of String
s which will be the key set of the returned Map
. If null
is specified, a mapping of all supported String
natives to their most preferred DataFlavor
s will be returned.java.util.Map
of String
natives to DataFlavor
spublic void addUnencodedNativeForFlavor(DataFlavor flav, String nat)
DataFlavor
(and all DataFlavor
s equal to the specified DataFlavor
) to the specified String
native. Unlike getNativesForFlavor
, the mapping will only be established in one direction, and the native will not be encoded. To establish a two-way mapping, call addFlavorForUnencodedNative
as well. The new mapping will be of lower priority than any existing mapping. This method has no effect if a mapping from the specified or equal DataFlavor
to the specified String
native already exists.flav
- the DataFlavor
key for the mappingnat
- the String
native value for the mappingNullPointerException
- if flav or nat is null
public void setNativesForFlavor(DataFlavor flav, String[] natives)
DataFlavor
and all DataFlavor
s equal to the specified DataFlavor
, and creates new mappings to the specified String
natives. Unlike getNativesForFlavor
, the mappings will only be established in one direction, and the natives will not be encoded. To establish two-way mappings, call setFlavorsForNative
as well. The first native in the array will represent the highest priority mapping. Subsequent natives will represent mappings of decreasing priority. If the array contains several elements that reference equal String
natives, this method will establish new mappings for the first of those elements and ignore the rest of them.
It is recommended that client code not reset mappings established by the data transfer subsystem. This method should only be used for application-level mappings.
flav
- the DataFlavor
key for the mappingsnatives
- the String
native values for the mappingsNullPointerException
- if flav or natives is null
or if natives contains null
elementspublic void addFlavorForUnencodedNative(String nat, DataFlavor flav)
String
native to a single DataFlavor
. Unlike getFlavorsForNative
, the mapping will only be established in one direction, and the native will not be encoded. To establish a two-way mapping, call addUnencodedNativeForFlavor
as well. The new mapping will be of lower priority than any existing mapping. This method has no effect if a mapping from the specified String
native to the specified or equal DataFlavor
already exists.nat
- the String
native key for the mappingflav
- the DataFlavor
value for the mappingNullPointerException
- if nat
or flav
is null
public void setFlavorsForNative(String nat, DataFlavor[] flavors)
String
native, and creates new mappings to the specified DataFlavor
s. Unlike getFlavorsForNative
, the mappings will only be established in one direction, and the natives need not be encoded. To establish two-way mappings, call setNativesForFlavor
as well. The first DataFlavor
in the array will represent the highest priority mapping. Subsequent DataFlavor
s will represent mappings of decreasing priority. If the array contains several elements that reference equal DataFlavor
s, this method will establish new mappings for the first of those elements and ignore the rest of them.
It is recommended that client code not reset mappings established by the data transfer subsystem. This method should only be used for application-level mappings.
nat
- the String
native key for the mappingsflavors
- the DataFlavor
values for the mappingsNullPointerException
- if nat
or flavors
is null
or if flavors
contains null
elementspublic static String encodeJavaMIMEType(String mimeType)
String
native. The format of an encoded representation of a MIME type is implementation-dependent. The only restrictions are: null
if and only if the MIME type String
is null
null
MIME type String
s are equal if and only if these String
s are equal according to String.equals(Object)
String
prefixed with JAVA_DATAFLAVOR:
.mimeType
- the MIME type to encodeString
, or null
if mimeType
is null
public static String encodeDataFlavor(DataFlavor flav)
DataFlavor
for use as a String
native. The format of an encoded DataFlavor
is implementation-dependent. The only restrictions are: null
if and only if the specified DataFlavor
is null
or its MIME type String
is null
null
DataFlavor
s with non-null
MIME type String
s are equal if and only if the MIME type String
s of these DataFlavor
s are equal according to String.equals(Object)
String
of the specified DataFlavor
prefixed with JAVA_DATAFLAVOR:
.flav
- the DataFlavor
to encodeString
, or null
if flav
is null
or has a null
MIME typepublic static boolean isJavaMIMEType(String str)
String
is an encoded Java MIME type.str
- the String
to testtrue
if the String
is encoded; false
otherwisepublic static String decodeJavaMIMEType(String nat)
String
native for use as a Java MIME type.nat
- the String
to decodenull
if nat
is not an encoded String
nativepublic static DataFlavor decodeDataFlavor(String nat) throws ClassNotFoundException
String
native for use as a DataFlavor
.nat
- the String
to decodeDataFlavor
, or null
if nat
is not an encoded String
nativeClassNotFoundException
- if the class of the data flavor is not loaded
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.datatransfer/java/awt/datatransfer/SystemFlavorMap.html