java.awt.datatransfer
Class DataFlavor

java.lang.Object
  |
  +--java.awt.datatransfer.DataFlavor

public class DataFlavor

extends Object

implements Externalizable, Cloneable

Each instance represents the opaque concept of a data format as would appear on a clipboard, during drag and drop, or in a file system.

See Also:

Serialized Form

Field Summary

static DataFlavor	javaFileListFlavor To transfer a list of files to/from Java (and the underlying platform) a DataFlavor of this type/subtype and representation class of java.util.List is used.
static String	javaJVMLocalObjectMimeType to transfer a reference to an arbitrary Java object reference that has no associated MIME Content-type, across a Transferable interface WITHIN THE SAME JVM, a DataFlavor with this type/subtype is used, with a representationClass equal to the type of the class/interface being passed across the Transferble.
static String	javaRemoteObjectMimeType In order to pass a live link to a Remote object via a Drag and Drop ACTION_LINK operation a Mime Content Type of application/x-java-remote-object should be used, where the representation class of the DataFlavor represents the type of the Remote interface to be transferred.
static String	javaSerializedObjectMimeType a MIME Content-Type of application/x-java-serialized-object represents a graph of Java object(s) that have been made persistent.
static DataFlavor	plainTextFlavor The DataFlavor representing plain text with unicode encoding, where: representationClass = InputStream mimeType = "text/plain; charset=unicode"
static DataFlavor	stringFlavor The DataFlavor representing a Java Unicode String class, where: representationClass = java.lang.String mimeType = "application/x-java-serialized-object"

Constructor Summary

DataFlavor()

DataFlavor(Class representationClass, String humanPresentableName)
Construct a DataFlavor that represents a Java class The returned DataFlavor will have the following characteristics representationClass = representationClass
mimeType = application/x-java-serialized-object

DataFlavor(String mimeType)
construct a DataFlavor from a Mime Type string.

DataFlavor(String mimeType, String humanPresentableName)
Construct a DataFlavor that represents a MimeType The returned DataFlavor will have the following characteristics: If the mimeType is "application/x-java-serialized-object; class=<representation class>", the result is the same as calling new DataFlavor(Class:forName(<representation class>) as above otherwise: representationClass = InputStream
mimeType = mimeType

DataFlavor(String mimeType, String humanPresentableName, ClassLoader classLoader)
Construct a DataFlavor that represents a MimeType The returned DataFlavor will have the following characteristics: If the mimeType is "application/x-java-serialized-object; class=<representation class>", the result is the same as calling new DataFlavor(Class:forName(<representation class>) as above otherwise: representationClass = InputStream
mimeType = mimeType

Method Summary

Object	clone()
boolean	equals(DataFlavor dataFlavor)
boolean	equals(Object o)
boolean	equals(String s)
String	getHumanPresentableName() Returns the human presentable name for the data foramt that this DataFlavor represents.
String	getMimeType() Returns the MIME type string for this DataFlavor
String	getParameter(String paramName)
String	getPrimaryType()
Class	getRepresentationClass() Returns the Class which objects supporting this DataFlavor will return when this DataFlavor is requested.
String	getSubType()
boolean	isFlavorJavaFileListType()
boolean	isFlavorRemoteObjectType()
boolean	isFlavorSerializedObjectType()
boolean	isMimeTypeEqual(DataFlavor dataFlavor)
boolean	isMimeTypeEqual(String mimeType) Is the string representation of the MIME type passed in equivalent to the MIME type of this DataFlavor.
boolean	isMimeTypeSerializedObject() does the DataFlavor represent a serialized object?
boolean	isRepresentationClassInputStream() does the DataFlavor represent a java.io.InputStream
boolean	isRepresentationClassRemote()
boolean	isRepresentationClassSerializable()
protected String	normalizeMimeType(String mimeType) Deprecated.
protected String	normalizeMimeTypeParameter(String parameterName, String parameterValue) Deprecated.
void	readExternal(ObjectInput is) restore this DataFlavor from an Serialized state
void	setHumanPresentableName(String humanPresentableName) Sets the human presentable name for the data format that this DataFlavor represents.
protected static Class	tryToLoadClass(String className, ClassLoader fallback) tried to load a class from: the bootstrap loader, the system loader, the context loader (if one is present) and finally the loader specified
void	writeExternal(ObjectOutput os) Serialize this DataFlavor

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

stringFlavor

public static final DataFlavor stringFlavor

The DataFlavor representing a Java Unicode String class, where:

representationClass = java.lang.String
mimeType = "application/x-java-serialized-object"

plainTextFlavor

public static final DataFlavor plainTextFlavor

The DataFlavor representing plain text with unicode encoding, where:

representationClass = InputStream
mimeType = "text/plain; charset=unicode"

javaSerializedObjectMimeType

public static final String javaSerializedObjectMimeType

a MIME Content-Type of application/x-java-serialized-object represents a graph of Java object(s) that have been made persistent. The representation class associated with this DataFlavor identifies the Java type of an object returned as a reference from an invocation java.awt.datatransfer.getTransferData().

javaFileListFlavor

public static final DataFlavor javaFileListFlavor

To transfer a list of files to/from Java (and the underlying platform) a DataFlavor of this type/subtype and representation class of java.util.List is used. Each element of the list is required/guaranteed to be of type java.io.File.

javaJVMLocalObjectMimeType

public static final String javaJVMLocalObjectMimeType

to transfer a reference to an arbitrary Java object reference that has no associated MIME Content-type, across a Transferable interface WITHIN THE SAME JVM, a DataFlavor with this type/subtype is used, with a representationClass equal to the type of the class/interface being passed across the Transferble. The object reference returned from Transferable.getTransferData() for a DataFlavor with this MIME Content-Type is required to be an instanceof the representation Class of the DataFlavor.

javaRemoteObjectMimeType

public static final String javaRemoteObjectMimeType

In order to pass a live link to a Remote object via a Drag and Drop ACTION_LINK operation a Mime Content Type of application/x-java-remote-object should be used, where the representation class of the DataFlavor represents the type of the Remote interface to be transferred.

Constructor Detail

DataFlavor

public DataFlavor(Class representationClass,
                  String humanPresentableName)

Construct a DataFlavor that represents a Java class

The returned DataFlavor will have the following characteristics

representationClass = representationClass
mimeType = application/x-java-serialized-object

Parameters:

representationClass - the class used to transfer data in this flavor

humanPresentableName - the human-readable string used to identify this flavor. If this parameter is null then the value of the the MIME Content Type is used.

DataFlavor

public DataFlavor(String mimeType,
                  String humanPresentableName)

Construct a DataFlavor that represents a MimeType

The returned DataFlavor will have the following characteristics:

If the mimeType is "application/x-java-serialized-object; class=<representation class>", the result is the same as calling new DataFlavor(Class:forName(<representation class>) as above

otherwise:

representationClass = InputStream
mimeType = mimeType

Parameters:

mimeType - the string used to identify the MIME type for this flavor. If the the mimeType does not specify a "class=" parameter, or if the class is not successfully loaded, then an IllegalArgumentException is thrown.

humanPresentableName - the human-readable string used to identify this flavor. If this parameter is null then the value of the the MIME Content Type is used.

DataFlavor

public DataFlavor(String mimeType,
                  String humanPresentableName,
                  ClassLoader classLoader)
           throws ClassNotFoundException

Construct a DataFlavor that represents a MimeType

The returned DataFlavor will have the following characteristics:

If the mimeType is "application/x-java-serialized-object; class=<representation class>", the result is the same as calling new DataFlavor(Class:forName(<representation class>) as above

otherwise:

representationClass = InputStream
mimeType = mimeType

Parameters:

mimeType - the string used to identify the MIME type for this flavor

humanPresentableName - the human-readible string used to identify this flavor

DataFlavor

public DataFlavor(String mimeType)
           throws ClassNotFoundException

construct a DataFlavor from a Mime Type string. The string must specify a "class=" parameter in order to succeed in constructing a DataFlavor.

Parameters:

mimeType - the string used to identify the MIME type for this flavor. If the the mimeType does not specify a "class=" parameter, or if the class is not successfully loaded, then an IllegalArgumentException is thrown.

DataFlavor

public DataFlavor()

Method Detail

tryToLoadClass

protected static final Class tryToLoadClass(String className,
                                            ClassLoader fallback)
                                     throws ClassNotFoundException

tried to load a class from: the bootstrap loader, the system loader, the context loader (if one is present) and finally the loader specified

Parameters:

fallback - the fallback loader

getMimeType

public String getMimeType()

Returns the MIME type string for this DataFlavor

getRepresentationClass

public Class getRepresentationClass()

Returns the Class which objects supporting this DataFlavor will return when this DataFlavor is requested.

getHumanPresentableName

public String getHumanPresentableName()

Returns the human presentable name for the data foramt that this DataFlavor represents. This name would be localized for different countries

getPrimaryType

public String getPrimaryType()

Returns:

the primary MIME type of this DataFlavor

getSubType

public String getSubType()

Returns:

the Sub MIME type of this DataFlavor

getParameter

public String getParameter(String paramName)

Returns:

the value of the name parameter

setHumanPresentableName

public void setHumanPresentableName(String humanPresentableName)

Sets the human presentable name for the data format that this DataFlavor represents. This name would be localized for different countries

equals

public boolean equals(Object o)

Returns:

if the objects are equal

Overrides:

equals in class Object

equals

public boolean equals(DataFlavor dataFlavor)

Returns:

if the DataFlavors represent the same type.

equals

public boolean equals(String s)

Returns:

if the String (MimeType) is equal

isMimeTypeEqual

public boolean isMimeTypeEqual(String mimeType)

Is the string representation of the MIME type passed in equivalent to the MIME type of this DataFlavor. This may involve adding default attributes for some MIME types (like adding charset=US-ASCII to text/plain MIME types that have no charset parameter specified)

isMimeTypeEqual

public final boolean isMimeTypeEqual(DataFlavor dataFlavor)

Returns:

if the MimeTypes are equal

isMimeTypeSerializedObject

public boolean isMimeTypeSerializedObject()

does the DataFlavor represent a serialized object?

isRepresentationClassInputStream

public boolean isRepresentationClassInputStream()

does the DataFlavor represent a java.io.InputStream

isRepresentationClassSerializable

public boolean isRepresentationClassSerializable()

Returns:

true if the representation class can be serialized

isRepresentationClassRemote

public boolean isRepresentationClassRemote()

Returns:

true if the representation class is Remote

isFlavorSerializedObjectType

public boolean isFlavorSerializedObjectType()

Returns:

if the DataFlavor specified represents a Serialized Object

isFlavorRemoteObjectType

public boolean isFlavorRemoteObjectType()

Returns:

if the DataFlavor specified represents a Remote Object

isFlavorJavaFileListType

public boolean isFlavorJavaFileListType()

Returns:

if flavor specified represents a List of File objects

writeExternal

public void writeExternal(ObjectOutput os)
                   throws IOException

Serialize this DataFlavor

Specified by:

writeExternal in interface Externalizable

readExternal

public void readExternal(ObjectInput is)
                  throws IOException,
                         ClassNotFoundException

restore this DataFlavor from an Serialized state

Specified by:

readExternal in interface Externalizable

clone

public Object clone()
             throws CloneNotSupportedException

Returns:

a clone of this DataFlavor

Overrides:

clone in class Object

normalizeMimeTypeParameter

protected String normalizeMimeTypeParameter(String parameterName,
                                            String parameterValue)

Deprecated.

Called on DataFlavor for every MIME Type parameter to allow DataFlavor subclasses to handle special parameters like the text/plain charset parameters, whose values are case insensitive. (MIME type parameter values are supposed to be case sensitive.

This method is called for each parameter name/value pair and should return the normalized representation of the parameterValue This method is never invoked by this implementation from 1.1 onwards

normalizeMimeType

protected String normalizeMimeType(String mimeType)

Deprecated.

Called for each MIME type string to give DataFlavor subtypes the opportunity to change how the normalization of MIME types is accomplished. One possible use would be to add default parameter/value pairs in cases where none are present in the MIME type string passed in This method is never invoked by this implementation from 1.1 onwards