Class DataFlavor
- All Implemented Interfaces:
Externalizable
,Serializable
,Cloneable
DataFlavor
provides meta information about data. DataFlavor
is typically used to access data on the clipboard, or during a drag and drop
operation.
An instance of DataFlavor
encapsulates a content type as defined in
RFC 2045 and
RFC 2046. A content type is
typically referred to as a MIME type.
A content type consists of a media type (referred to as the primary type), a subtype, and optional parameters. See RFC 2045 for details on the syntax of a MIME type.
The JRE data transfer implementation interprets the parameter
"class" of a MIME type as a representation class. The
representation class reflects the class of the object being transferred. In
other words, the representation class is the type of object returned by
Transferable.getTransferData(java.awt.datatransfer.DataFlavor)
. For example, the MIME type of
imageFlavor
is "image/x-java-image;class=java.awt.Image"
,
the primary type is image
, the subtype is x-java-image
, and
the representation class is java.awt.Image
. When
getTransferData
is invoked with a DataFlavor
of
imageFlavor
, an instance of java.awt.Image
is returned. It's
important to note that DataFlavor
does no error checking against the
representation class. It is up to consumers of DataFlavor
, such as
Transferable
, to honor the representation class.
Note, if you do not specify a representation class when creating a
DataFlavor
, the default representation class is used. See appropriate
documentation for DataFlavor
's constructors.
Also, DataFlavor
instances with the "text" primary MIME
type may have a "charset" parameter. Refer to
RFC 2046 and
selectBestTextFlavor(java.awt.datatransfer.DataFlavor[])
for details on "text" MIME types and
the "charset" parameter.
Equality of DataFlavors
is determined by the primary type, subtype,
and representation class. Refer to equals(DataFlavor)
for details.
When determining equality, any optional parameters are ignored. For example,
the following produces two DataFlavors
that are considered identical:
DataFlavor flavor1 = new DataFlavor(Object.class, "X-test/test; class=<java.lang.Object>; foo=bar"); DataFlavor flavor2 = new DataFlavor(Object.class, "X-test/test; class=<java.lang.Object>; x=y"); // The following returns true. flavor1.equals(flavor2);As mentioned,
flavor1
and flavor2
are considered identical.
As such, asking a Transferable
for either DataFlavor
returns
the same results.
For more information on using data transfer with Swing see the How to Use Drag and Drop and Data Transfer, section in The Java Tutorial.
- Since:
- 1.1
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final DataFlavor
Represents a piece of an HTML markup.static final DataFlavor
Represents a piece of an HTML markup.static final DataFlavor
TheDataFlavor
representing a Java Image class, where:static final DataFlavor
To transfer a list of files to/from Java (and the underlying platform) aDataFlavor
of this type/subtype and representation class ofjava.util.List
is used.static final String
To transfer a reference to an arbitrary Java object reference that has no associated MIME Content-type, across aTransferable
interface WITHIN THE SAME JVM, aDataFlavor
with this type/subtype is used, with arepresentationClass
equal to the type of the class/interface being passed across theTransferable
.static final String
In order to pass a live link to a Remote object via a Drag and DropACTION_LINK
operation a Mime Content Type of application/x-java-remote-object should be used, where the representation class of theDataFlavor
represents the type of theRemote
interface to be transferred.static final String
A MIME Content-Type of application/x-java-serialized-object represents a graph of Java object(s) that have been made persistent.static final DataFlavor
Deprecated.as of 1.3.static final DataFlavor
Represents a piece of an HTML markup.static final DataFlavor
TheDataFlavor
representing a Java Unicode String class, where: -
Constructor Summary
ConstructorDescriptionConstructs a newDataFlavor
.DataFlavor
(Class<?> representationClass, String humanPresentableName) Constructs aDataFlavor
that represents a Java class.DataFlavor
(String mimeType) Constructs aDataFlavor
from amimeType
string.DataFlavor
(String mimeType, String humanPresentableName) Constructs aDataFlavor
that represents aMimeType
.DataFlavor
(String mimeType, String humanPresentableName, ClassLoader classLoader) Constructs aDataFlavor
that represents aMimeType
. -
Method Summary
Modifier and TypeMethodDescriptionclone()
Returns a clone of thisDataFlavor
.boolean
equals
(DataFlavor that) This method has the same behavior asequals(Object)
.boolean
Indicates whether some other object is "equal to" this one.boolean
Deprecated.As inconsistent withhashCode()
contract, useisMimeTypeEqual(String)
instead.final Class
<?> Returns the default representation class.final String
Returns the name of the default representation class.Returns the human presentable name for the data format that thisDataFlavor
represents.Returns the MIME type string for thisDataFlavor
.getParameter
(String paramName) Returns the human presentable name for thisDataFlavor
ifparamName
equals "humanPresentableName".Returns the primary MIME type for thisDataFlavor
.getReaderForText
(Transferable transferable) Gets a Reader for a text flavor, decoded, if necessary, for the expected charset (encoding).Class
<?> Returns theClass
which objects supporting thisDataFlavor
will return when thisDataFlavor
is requested.Returns the sub MIME type of thisDataFlavor
.static final DataFlavor
Returns aDataFlavor
representing plain text with Unicode encoding, where:int
hashCode()
Returns hash code for thisDataFlavor
.boolean
Returnstrue
if theDataFlavor
specified represents a list of file objects.boolean
Returnstrue
if theDataFlavor
specified represents a remote object.boolean
Returnstrue
if theDataFlavor
specified represents a serialized object.boolean
Returns whether thisDataFlavor
is a valid text flavor for this implementation of the Java platform.final boolean
isMimeTypeEqual
(DataFlavor dataFlavor) Compares themimeType
of twoDataFlavor
objects.boolean
isMimeTypeEqual
(String mimeType) Returns whether the string representation of the MIME type passed in is equivalent to the MIME type of thisDataFlavor
.boolean
Does theDataFlavor
represent a serialized object?boolean
Returns whether the representation class for thisDataFlavor
isjava.nio.ByteBuffer
or a subclass thereof.boolean
Returns whether the representation class for thisDataFlavor
isjava.nio.CharBuffer
or a subclass thereof.boolean
Does theDataFlavor
represent ajava.io.InputStream
?boolean
Returns whether the representation class for thisDataFlavor
isjava.io.Reader
or a subclass thereof.boolean
Returnstrue
if the representation class isRemote
.boolean
Returnstrue
if the representation class can be serialized.boolean
match
(DataFlavor that) Identical toequals(DataFlavor)
.protected String
normalizeMimeType
(String mimeType) Deprecated.This method is never invoked by this implementation from 1.1 onwardsprotected String
normalizeMimeTypeParameter
(String parameterName, String parameterValue) Deprecated.This method is never invoked by this implementation from 1.1 onwardsvoid
Restores thisDataFlavor
from a Serialized state.static final DataFlavor
selectBestTextFlavor
(DataFlavor[] availableFlavors) Selects the best textDataFlavor
from an array ofDataFlavor
s.void
setHumanPresentableName
(String humanPresentableName) Sets the human presentable name for the data format that thisDataFlavor
represents.toString()
String representation of thisDataFlavor
and its parameters.protected static final Class
<?> tryToLoadClass
(String className, ClassLoader fallback) Tries to load a class from: the bootstrap loader, the system loader, the context loader (if one is present) and finally the loader specified.void
Serializes thisDataFlavor
.
-
Field Details
-
stringFlavor
TheDataFlavor
representing a Java Unicode String class, where:representationClass = java.lang.String mimeType = "application/x-java-serialized-object"
-
imageFlavor
TheDataFlavor
representing a Java Image class, where:representationClass = java.awt.Image mimeType = "image/x-java-image"
Will benull
ifjava.awt.Image
is not visible, thejava.desktop
module is not loaded, or thejava.desktop
module is not in the run-time image. -
plainTextFlavor
Deprecated.as of 1.3. UsegetReaderForText(java.awt.datatransfer.Transferable)
instead ofTransferable.getTransferData(DataFlavor.plainTextFlavor)
.TheDataFlavor
representing plain text with Unicode encoding, where:representationClass = InputStream mimeType = "text/plain; charset=unicode"
ThisDataFlavor
has been deprecated because:- Its representation is an InputStream, an 8-bit based representation, while Unicode is a 16-bit character set
- The charset "unicode" is not well-defined. "unicode" implies a particular platform's implementation of Unicode, not a cross-platform implementation
-
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 invocationjava.awt.datatransfer.getTransferData
.- See Also:
-
javaFileListFlavor
To transfer a list of files to/from Java (and the underlying platform) aDataFlavor
of this type/subtype and representation class ofjava.util.List
is used. Each element of the list is required/guaranteed to be of typejava.io.File
. -
javaJVMLocalObjectMimeType
To transfer a reference to an arbitrary Java object reference that has no associated MIME Content-type, across aTransferable
interface WITHIN THE SAME JVM, aDataFlavor
with this type/subtype is used, with arepresentationClass
equal to the type of the class/interface being passed across theTransferable
.The object reference returned from
Transferable.getTransferData
for aDataFlavor
with this MIME Content-Type is required to be an instance of the representation Class of theDataFlavor
.- See Also:
-
javaRemoteObjectMimeType
In order to pass a live link to a Remote object via a Drag and DropACTION_LINK
operation a Mime Content Type of application/x-java-remote-object should be used, where the representation class of theDataFlavor
represents the type of theRemote
interface to be transferred.- See Also:
-
selectionHtmlFlavor
Represents a piece of an HTML markup. The markup consists of the part selected on the source side. Therefore some tags in the markup may be unpaired. If the flavor is used to represent the data in aTransferable
instance, no additional changes will be made. This DataFlavor instance represents the same HTML markup as DataFlavor instances which content MIME type does not contain document parameter and representation class is the String class.representationClass = String mimeType = "text/html"
- Since:
- 1.8
-
fragmentHtmlFlavor
Represents a piece of an HTML markup. If possible, the markup received from a native system is supplemented with pair tags to be a well-formed HTML markup. If the flavor is used to represent the data in aTransferable
instance, no additional changes will be made.representationClass = String mimeType = "text/html"
- Since:
- 1.8
-
allHtmlFlavor
Represents a piece of an HTML markup. If possible, the markup received from a native system is supplemented with additional tags to make up a well-formed HTML document. If the flavor is used to represent the data in aTransferable
instance, no additional changes will be made.representationClass = String mimeType = "text/html"
- Since:
- 1.8
-
-
Constructor Details
-
DataFlavor
public DataFlavor()Constructs a newDataFlavor
. This constructor is provided only for the purpose of supporting theExternalizable
interface. It is not intended for public (client) use.- Since:
- 1.2
-
DataFlavor
Constructs aDataFlavor
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 flavorhumanPresentableName
- the human-readable string used to identify this flavor; if this parameter isnull
then the value of the MIME Content Type is used- Throws:
NullPointerException
- ifrepresentationClass
isnull
-
DataFlavor
Constructs aDataFlavor
that represents aMimeType
.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 callingnew DataFlavor(Class.forName(<representation class>)
.Otherwise:
representationClass = InputStream mimeType = mimeType
- Parameters:
mimeType
- the string used to identify the MIME type for this flavor; if themimeType
does not specify a "class=" parameter, or if the class is not successfully loaded, then anIllegalArgumentException
is thrownhumanPresentableName
- the human-readable string used to identify this flavor; if this parameter isnull
then the value of the MIME Content Type is used- Throws:
IllegalArgumentException
- ifmimeType
is invalid or if the class is not successfully loadedNullPointerException
- ifmimeType
isnull
-
DataFlavor
public DataFlavor(String mimeType, String humanPresentableName, ClassLoader classLoader) throws ClassNotFoundException Constructs aDataFlavor
that represents aMimeType
.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>)
.Otherwise:
representationClass = InputStream mimeType = mimeType
- Parameters:
mimeType
- the string used to identify the MIME type for this flavorhumanPresentableName
- the human-readable string used to identify this flavorclassLoader
- the class loader to use- Throws:
ClassNotFoundException
- if the class is not loadedIllegalArgumentException
- ifmimeType
is invalidNullPointerException
- ifmimeType
isnull
-
DataFlavor
Constructs aDataFlavor
from amimeType
string. The string can specify a "class=<fully specified Java class name>" parameter to create aDataFlavor
with the desired representation class. If the string does not contain "class=" parameter,java.io.InputStream
is used as default.- Parameters:
mimeType
- the string used to identify the MIME type for this flavor; if the class specified by "class=" parameter is not successfully loaded, then aClassNotFoundException
is thrown- Throws:
ClassNotFoundException
- if the class is not loadedIllegalArgumentException
- ifmimeType
is invalidNullPointerException
- ifmimeType
isnull
-
-
Method Details
-
tryToLoadClass
protected static final Class<?> tryToLoadClass(String className, ClassLoader fallback) throws ClassNotFoundException Tries to load a class from: the bootstrap loader, the system loader, the context loader (if one is present) and finally the loader specified.- Parameters:
className
- the name of the class to be loadedfallback
- the fallback loader- Returns:
- the class loaded
- Throws:
ClassNotFoundException
- if class is not found
-
toString
String representation of thisDataFlavor
and its parameters. The resultingString
contains the name of theDataFlavor
class, this flavor's MIME type, and its representation class. If this flavor has a primary MIME type of "text", supports the charset parameter, and has an encoded representation, the flavor's charset is also included. SeeselectBestTextFlavor
for a list of text flavors which support the charset parameter. -
getTextPlainUnicodeFlavor
Returns aDataFlavor
representing plain text with Unicode encoding, where:representationClass = java.io.InputStream mimeType = "text/plain; charset=<platform default Unicode encoding>"
- Implementation Note:
- Oracle's implementation for Microsoft Windows and macOS uses
the encoding
utf-16le
. Oracle's implementation for Solaris and Linux uses the encodingiso-10646-ucs-2
. - Returns:
- a
DataFlavor
representing plain text with Unicode encoding - Since:
- 1.3
-
selectBestTextFlavor
Selects the best textDataFlavor
from an array ofDataFlavor
s. OnlyDataFlavor.stringFlavor
, and equivalent flavors, and flavors that have a primary MIME type of "text", are considered for selection.Flavors are first sorted by their MIME types in the following order:
- "text/sgml"
- "text/xml"
- "text/html"
- "text/rtf"
- "text/enriched"
- "text/richtext"
- "text/uri-list"
- "text/tab-separated-values"
- "text/t140"
- "text/rfc822-headers"
- "text/parityfec"
- "text/directory"
- "text/css"
- "text/calendar"
- "application/x-java-serialized-object"
- "text/plain"
- "text/<other>"
For example, "text/sgml" will be selected over "text/html", and
DataFlavor.stringFlavor
will be chosen overDataFlavor.plainTextFlavor
.If two or more flavors share the best MIME type in the array, then that MIME type will be checked to see if it supports the charset parameter.
The following MIME types support, or are treated as though they support, the charset parameter:
- "text/sgml"
- "text/xml"
- "text/html"
- "text/enriched"
- "text/richtext"
- "text/uri-list"
- "text/directory"
- "text/css"
- "text/calendar"
- "application/x-java-serialized-object"
- "text/plain"
- "text/rtf"
- "text/tab-separated-values"
- "text/t140"
- "text/rfc822-headers"
- "text/parityfec"
DataFlavor
which uses that MIME type. If so, the JRE will assume from that point on that the MIME type supports the charset parameter and will not check again. If the parameter is not explicitly listed, the JRE will assume from that point on that the MIME type does not support the charset parameter and will not check again. Because this check is performed on an arbitrarily chosenDataFlavor
, developers must ensure that allDataFlavor
s with a "text/<other>" MIME type specify the charset parameter if it is supported by that MIME type. Developers should never rely on the JRE to substitute the platform's default charset for a "text/<other>" DataFlavor. Failure to adhere to this restriction will lead to undefined behavior.If the best MIME type in the array does not support the charset parameter, the flavors which share that MIME type will then be sorted by their representation classes in the following order:
java.io.InputStream
,java.nio.ByteBuffer
,[B
, <all others>.If two or more flavors share the best representation class, or if no flavor has one of the three specified representations, then one of those flavors will be chosen non-deterministically.
If the best MIME type in the array does support the charset parameter, the flavors which share that MIME type will then be sorted by their representation classes in the following order:
java.io.Reader
,java.lang.String
,java.nio.CharBuffer
,[C
, <all others>.If two or more flavors share the best representation class, and that representation is one of the four explicitly listed, then one of those flavors will be chosen non-deterministically. If, however, no flavor has one of the four specified representations, the flavors will then be sorted by their charsets. Unicode charsets, such as "UTF-16", "UTF-8", "UTF-16BE", "UTF-16LE", and their aliases, are considered best. After them, the platform default charset and its aliases are selected. "US-ASCII" and its aliases are worst. All other charsets are chosen in alphabetical order, but only charsets supported by this implementation of the Java platform will be considered.
If two or more flavors share the best charset, the flavors will then again be sorted by their representation classes in the following order:
java.io.InputStream
,java.nio.ByteBuffer
,[B
, <all others>.If two or more flavors share the best representation class, or if no flavor has one of the three specified representations, then one of those flavors will be chosen non-deterministically.
- Parameters:
availableFlavors
- an array of availableDataFlavor
s- Returns:
- the best (highest fidelity) flavor according to the rules
specified above, or
null
, ifavailableFlavors
isnull
, has zero length, or contains no text flavors - Since:
- 1.3
-
getReaderForText
public Reader getReaderForText(Transferable transferable) throws UnsupportedFlavorException, IOException Gets a Reader for a text flavor, decoded, if necessary, for the expected charset (encoding). The supported representation classes arejava.io.Reader
,java.lang.String
,java.nio.CharBuffer
,[C
,java.io.InputStream
,java.nio.ByteBuffer
, and[B
.Because text flavors which do not support the charset parameter are encoded in a non-standard format, this method should not be called for such flavors. However, in order to maintain backward-compatibility, if this method is called for such a flavor, this method will treat the flavor as though it supports the charset parameter and attempt to decode it accordingly. See
selectBestTextFlavor
for a list of text flavors which do not support the charset parameter.- Parameters:
transferable
- theTransferable
whose data will be requested in this flavor- Returns:
- a
Reader
to read theTransferable
's data - Throws:
IllegalArgumentException
- if the representation class is not one of the seven listed aboveIllegalArgumentException
- if theTransferable
hasnull
dataNullPointerException
- if theTransferable
isnull
UnsupportedEncodingException
- if this flavor's representation isjava.io.InputStream
,java.nio.ByteBuffer
, or[B
and this flavor's encoding is not supported by this implementation of the Java platformUnsupportedFlavorException
- if theTransferable
does not support this flavorIOException
- if the data cannot be read because of an I/O error- Since:
- 1.3
- See Also:
-
getMimeType
Returns the MIME type string for thisDataFlavor
.- Returns:
- the MIME type string for this flavor
-
getRepresentationClass
Returns theClass
which objects supporting thisDataFlavor
will return when thisDataFlavor
is requested.- Returns:
- the
Class
which objects supporting thisDataFlavor
will return when thisDataFlavor
is requested
-
getHumanPresentableName
Returns the human presentable name for the data format that thisDataFlavor
represents. This name would be localized for different countries.- Returns:
- the human presentable name for the data format that this
DataFlavor
represents
-
getPrimaryType
Returns the primary MIME type for thisDataFlavor
.- Returns:
- the primary MIME type of this
DataFlavor
-
getSubType
Returns the sub MIME type of thisDataFlavor
.- Returns:
- the Sub MIME type of this
DataFlavor
-
getParameter
Returns the human presentable name for thisDataFlavor
ifparamName
equals "humanPresentableName". Otherwise returns the MIME type value associated withparamName
.- Parameters:
paramName
- the parameter name requested- Returns:
- the value of the name parameter, or
null
if there is no associated value
-
setHumanPresentableName
Sets the human presentable name for the data format that thisDataFlavor
represents. This name would be localized for different countries.- Parameters:
humanPresentableName
- the new human presentable name
-
equals
Indicates whether some other object is "equal to" this one.The
equals
method implements an equivalence relation on non-null object references:- It is reflexive: for any non-null reference value
x
,x.equals(x)
should returntrue
. - It is symmetric: for any non-null reference values
x
andy
,x.equals(y)
should returntrue
if and only ify.equals(x)
returnstrue
. - It is transitive: for any non-null reference values
x
,y
, andz
, ifx.equals(y)
returnstrue
andy.equals(z)
returnstrue
, thenx.equals(z)
should returntrue
. - It is consistent: for any non-null reference values
x
andy
, multiple invocations ofx.equals(y)
consistently returntrue
or consistently returnfalse
, provided no information used inequals
comparisons on the objects is modified. - For any non-null reference value
x
,x.equals(null)
should returnfalse
.
An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.
The equals comparison for the
DataFlavor
class is implemented as follows: TwoDataFlavor
s are considered equal if and only if their MIME primary type and subtype and representation class are equal. Additionally, if the primary type is "text", the subtype denotes a text flavor which supports the charset parameter, and the representation class is notjava.io.Reader
,java.lang.String
,java.nio.CharBuffer
, or[C
, thecharset
parameter must also be equal. If a charset is not explicitly specified for one or bothDataFlavor
s, the platform default encoding is assumed. SeeselectBestTextFlavor
for a list of text flavors which support the charset parameter. - It is reflexive: for any non-null reference value
-
equals
This method has the same behavior asequals(Object)
. The only difference being that it takes aDataFlavor
instance as a parameter.- Parameters:
that
- theDataFlavor
to compare withthis
- Returns:
true
ifthat
is equivalent to thisDataFlavor
;false
otherwise- See Also:
-
equals
Deprecated.As inconsistent withhashCode()
contract, useisMimeTypeEqual(String)
instead.Compares only themimeType
against the passed inString
andrepresentationClass
is not considered in the comparison. IfrepresentationClass
needs to be compared, thenequals(new DataFlavor(s))
may be used.- Parameters:
s
- themimeType
to compare- Returns:
true
if the String (MimeType) is equal;false
otherwise or ifs
isnull
-
hashCode
public int hashCode()Returns hash code for thisDataFlavor
. For two equalDataFlavor
s, hash codes are equal. For theString
that matchesDataFlavor.equals(String)
, it is not guaranteed thatDataFlavor
's hash code is equal to the hash code of theString
. -
match
Identical toequals(DataFlavor)
.- Parameters:
that
- theDataFlavor
to compare withthis
- Returns:
true
ifthat
is equivalent to thisDataFlavor
;false
otherwise- Since:
- 1.3
- See Also:
-
isMimeTypeEqual
Returns whether the string representation of the MIME type passed in is equivalent to the MIME type of thisDataFlavor
. Parameters are not included in the comparison.- Parameters:
mimeType
- the string representation of the MIME type- Returns:
true
if the string representation of the MIME type passed in is equivalent to the MIME type of thisDataFlavor
;false
otherwise- Throws:
NullPointerException
- if mimeType isnull
-
isMimeTypeEqual
Compares themimeType
of twoDataFlavor
objects. No parameters are considered.- Parameters:
dataFlavor
- theDataFlavor
to be compared- Returns:
true
if theMimeType
s are equal, otherwisefalse
-
isMimeTypeSerializedObject
public boolean isMimeTypeSerializedObject()Does theDataFlavor
represent a serialized object?- Returns:
- whether or not a serialized object is represented
-
getDefaultRepresentationClass
Returns the default representation class.- Returns:
- the default representation class
-
getDefaultRepresentationClassAsString
Returns the name of the default representation class.- Returns:
- the name of the default representation class
-
isRepresentationClassInputStream
public boolean isRepresentationClassInputStream()Does theDataFlavor
represent ajava.io.InputStream
?- Returns:
- whether or not this
DataFlavor
represent ajava.io.InputStream
-
isRepresentationClassReader
public boolean isRepresentationClassReader()Returns whether the representation class for thisDataFlavor
isjava.io.Reader
or a subclass thereof.- Returns:
- whether or not the representation class for this
DataFlavor
isjava.io.Reader
or a subclass thereof - Since:
- 1.4
-
isRepresentationClassCharBuffer
public boolean isRepresentationClassCharBuffer()Returns whether the representation class for thisDataFlavor
isjava.nio.CharBuffer
or a subclass thereof.- Returns:
- whether or not the representation class for this
DataFlavor
isjava.nio.CharBuffer
or a subclass thereof - Since:
- 1.4
-
isRepresentationClassByteBuffer
public boolean isRepresentationClassByteBuffer()Returns whether the representation class for thisDataFlavor
isjava.nio.ByteBuffer
or a subclass thereof.- Returns:
- whether or not the representation class for this
DataFlavor
isjava.nio.ByteBuffer
or a subclass thereof - Since:
- 1.4
-
isRepresentationClassSerializable
public boolean isRepresentationClassSerializable()Returnstrue
if the representation class can be serialized.- Returns:
true
if the representation class can be serialized
-
isRepresentationClassRemote
public boolean isRepresentationClassRemote()Returnstrue
if the representation class isRemote
.- Returns:
true
if the representation class isRemote
-
isFlavorSerializedObjectType
public boolean isFlavorSerializedObjectType()Returnstrue
if theDataFlavor
specified represents a serialized object.- Returns:
true
if theDataFlavor
specified represents a Serialized Object
-
isFlavorRemoteObjectType
public boolean isFlavorRemoteObjectType()Returnstrue
if theDataFlavor
specified represents a remote object.- Returns:
true
if theDataFlavor
specified represents a Remote Object
-
isFlavorJavaFileListType
public boolean isFlavorJavaFileListType()Returnstrue
if theDataFlavor
specified represents a list of file objects.- Returns:
true
if theDataFlavor
specified represents ajava.util.List
ofjava.io.File
objects
-
isFlavorTextType
public boolean isFlavorTextType()Returns whether thisDataFlavor
is a valid text flavor for this implementation of the Java platform. Only flavors equivalent toDataFlavor.stringFlavor
andDataFlavor
s with a primary MIME type of "text" can be valid text flavors.If this flavor supports the charset parameter, it must be equivalent to
DataFlavor.stringFlavor
, or its representation must bejava.io.Reader
,java.lang.String
,java.nio.CharBuffer
,[C
,java.io.InputStream
,java.nio.ByteBuffer
, or[B
. If the representation isjava.io.InputStream
,java.nio.ByteBuffer
, or[B
, then this flavor'scharset
parameter must be supported by this implementation of the Java platform. If a charset is not specified, then the platform default charset, which is always supported, is assumed.If this flavor does not support the charset parameter, its representation must be
java.io.InputStream
,java.nio.ByteBuffer
, or[B
.See
selectBestTextFlavor
for a list of text flavors which support the charset parameter.- Returns:
true
if thisDataFlavor
is a valid text flavor as described above;false
otherwise- Since:
- 1.4
- See Also:
-
writeExternal
Serializes thisDataFlavor
.- Specified by:
writeExternal
in interfaceExternalizable
- Parameters:
os
- the stream to write the object to- Throws:
IOException
- Includes any I/O exceptions that may occur
-
readExternal
Restores thisDataFlavor
from a Serialized state.- Specified by:
readExternal
in interfaceExternalizable
- Parameters:
is
- the stream to read data from in order to restore the object- Throws:
IOException
- if I/O errors occurClassNotFoundException
- If the class for an object being restored cannot be found.
-
clone
Returns a clone of thisDataFlavor
.- Overrides:
clone
in classObject
- Returns:
- a clone of this
DataFlavor
- Throws:
CloneNotSupportedException
- if the object's class does not support theCloneable
interface. Subclasses that override theclone
method can also throw this exception to indicate that an instance cannot be cloned.- See Also:
-
normalizeMimeTypeParameter
@Deprecated protected String normalizeMimeTypeParameter(String parameterName, String parameterValue) Deprecated.This method is never invoked by this implementation from 1.1 onwardsCalled onDataFlavor
for every MIME Type parameter to allowDataFlavor
subclasses to handle special parameters like the text/plaincharset
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
.- Parameters:
parameterName
- the parameter nameparameterValue
- the parameter value- Returns:
- the parameter value
-
normalizeMimeType
Deprecated.This method is never invoked by this implementation from 1.1 onwardsCalled for each MIME type string to giveDataFlavor
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.- Parameters:
mimeType
- the mime type- Returns:
- the mime type
-