|
JavaTM 2 Platform Std. Ed. v1.4.2 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object java.awt.datatransfer.DataFlavor
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.
DataFlavor
objects are constant and never change once
instantiated.
Field Summary | |
static DataFlavor |
imageFlavor
The DataFlavor representing a Java Image class,
where:
|
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
Deprecated. as of 1.3. Use DataFlavor.getReaderForText(
Transferable) instead of Transferable.
getTransferData(DataFlavor.plainTextFlavor) . |
static DataFlavor |
stringFlavor
The DataFlavor representing a Java Unicode String class,
where:
|
Constructor Summary | |
DataFlavor()
Constructs a new DataFlavor . |
|
DataFlavor(Class representationClass,
String humanPresentableName)
Constructs a DataFlavor that represents a Java class. |
|
DataFlavor(String mimeType)
Constructs a DataFlavor from a mimeType string. |
|
DataFlavor(String mimeType,
String humanPresentableName)
Constructs a DataFlavor that represents a
MimeType . |
|
DataFlavor(String mimeType,
String humanPresentableName,
ClassLoader classLoader)
Constructs a DataFlavor that represents a
MimeType . |
Method Summary | |
Object |
clone()
Returns a clone of this DataFlavor . |
boolean |
equals(DataFlavor that)
Tests a DataFlavor to this DataFlavor for
equality. |
boolean |
equals(Object o)
Tests an arbitrary Object to this DataFlavor
for equality. |
boolean |
equals(String s)
Deprecated. As inconsistent with hashCode() contract,
use isMimeTypeEqual(String) instead. |
Class |
getDefaultRepresentationClass()
|
String |
getDefaultRepresentationClassAsString()
|
String |
getHumanPresentableName()
Returns the human presentable name for the data format that this DataFlavor represents. |
String |
getMimeType()
Returns the MIME type string for this DataFlavor . |
String |
getParameter(String paramName)
Returns the human presentable name for this DataFlavor
if paramName equals "humanPresentableName". |
String |
getPrimaryType()
Returns the primary MIME type for this DataFlavor . |
Reader |
getReaderForText(Transferable transferable)
Gets a Reader for a text flavor, decoded, if necessary, for the expected charset (encoding). |
Class |
getRepresentationClass()
Returns the Class which objects supporting this
DataFlavor will return when this DataFlavor
is requested. |
String |
getSubType()
Returns the sub MIME type of this DataFlavor . |
static DataFlavor |
getTextPlainUnicodeFlavor()
Returns a DataFlavor representing plain text with Unicode
encoding, where:
|
int |
hashCode()
Returns hash code for this DataFlavor . |
boolean |
isFlavorJavaFileListType()
Returns true if the DataFlavor specified represents
a list of file objects. |
boolean |
isFlavorRemoteObjectType()
Returns true if the DataFlavor specified represents
a remote object. |
boolean |
isFlavorSerializedObjectType()
Returns true if the DataFlavor specified represents
a serialized object. |
boolean |
isFlavorTextType()
Returns whether this DataFlavor is a valid text flavor for
this implementation of the Java platform. |
boolean |
isMimeTypeEqual(DataFlavor dataFlavor)
Compares the mimeType of two DataFlavor
objects. |
boolean |
isMimeTypeEqual(String mimeType)
Returns whether the string representation of the MIME type passed in is equivalent to the MIME type of this DataFlavor . |
boolean |
isMimeTypeSerializedObject()
Does the DataFlavor represent a serialized object? |
boolean |
isRepresentationClassByteBuffer()
Returns whether the representation class for this DataFlavor is java.nio.ByteBuffer or a
subclass thereof. |
boolean |
isRepresentationClassCharBuffer()
Returns whether the representation class for this DataFlavor is java.nio.CharBuffer or a
subclass thereof. |
boolean |
isRepresentationClassInputStream()
Does the DataFlavor represent a
java.io.InputStream ? |
boolean |
isRepresentationClassReader()
Returns whether the representation class for this DataFlavor is java.io.Reader or a subclass
thereof. |
boolean |
isRepresentationClassRemote()
Returns true if the representation class is Remote . |
boolean |
isRepresentationClassSerializable()
Returns true if the representation class can be serialized. |
boolean |
match(DataFlavor that)
Tests a DataFlavor to this DataFlavor for
equality. |
protected String |
normalizeMimeType(String mimeType)
Deprecated. |
protected String |
normalizeMimeTypeParameter(String parameterName,
String parameterValue)
Deprecated. |
void |
readExternal(ObjectInput is)
Restores this DataFlavor from a Serialized state. |
static DataFlavor |
selectBestTextFlavor(DataFlavor[] availableFlavors)
Selects the best text DataFlavor from an array of
DataFlavor s. |
void |
setHumanPresentableName(String humanPresentableName)
Sets the human presentable name for the data format that this DataFlavor represents. |
String |
toString()
String representation of this DataFlavor and its
parameters. |
protected static 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 |
writeExternal(ObjectOutput os)
Serializes this DataFlavor . |
Methods inherited from class java.lang.Object |
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final DataFlavor stringFlavor
DataFlavor
representing a Java Unicode String class,
where:
representationClass = java.lang.String mimeType = "application/x-java-serialized-object"
public static final DataFlavor imageFlavor
DataFlavor
representing a Java Image class,
where:
representationClass = java.awt.Image mimeType = "image/x-java-image"
public static final DataFlavor plainTextFlavor
DataFlavor.getReaderForText(
Transferable)
instead of Transferable.
getTransferData(DataFlavor.plainTextFlavor)
.
DataFlavor
representing plain text with Unicode
encoding, where:
representationClass = InputStream mimeType = "text/plain; charset=unicode"This
DataFlavor
has been deprecated because
(1) Its representation is an InputStream, an 8-bit based representation,
while Unicode is a 16-bit character set; and (2) The charset "unicode"
is not well-defined. "unicode" implies a particular platform's
implementation of Unicode, not a cross-platform implementation.
public static final String javaSerializedObjectMimeType
DataFlavor
identifies the Java type of an object returned as a reference
from an invocation java.awt.datatransfer.getTransferData
.
public static final DataFlavor javaFileListFlavor
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
.
public static final String javaJVMLocalObjectMimeType
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 instance of the representation Class of the DataFlavor
.
public static final String javaRemoteObjectMimeType
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 |
public DataFlavor()
DataFlavor
. This constructor is
provided only for the purpose of supporting the
Externalizable
interface. It is not
intended for public (client) use.
public DataFlavor(Class representationClass, String humanPresentableName)
DataFlavor
that represents a Java class.
The returned DataFlavor
will have the following
characteristics:
representationClass = representationClass mimeType = application/x-java-serialized-object
representationClass
- the class used to transfer data in this flavorhumanPresentableName
- 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
NullPointerException
- if representationClass
is nullpublic DataFlavor(String mimeType, String humanPresentableName)
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>)
.
Otherwise:
representationClass = InputStream mimeType = mimeType
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 thrownhumanPresentableName
- 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
IllegalArgumentException
- if mimeType
is
invalid or if the class is not successfully loaded
NullPointerException
- if mimeType
is nullpublic DataFlavor(String mimeType, String humanPresentableName, ClassLoader classLoader) throws ClassNotFoundException
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>)
.
Otherwise:
representationClass = InputStream mimeType = mimeType
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
ClassNotFoundException
- if the class is not loaded
IllegalArgumentException
- if mimeType
is
invalid
NullPointerException
- if mimeType
is nullpublic DataFlavor(String mimeType) throws ClassNotFoundException
DataFlavor
from a mimeType
string.
The string can specify a "class=DataFlavor
with the desired
representation class. If the string does not contain "class=" parameter,
java.io.InputStream
is used as default.
mimeType
- the string used to identify the MIME type for this flavor;
if the class specified by "class=" parameter is not
successfully loaded, then an
ClassNotFoundException
is thrown
ClassNotFoundException
- if the class is not loaded
IllegalArgumentException
- if mimeType
is
invalid
NullPointerException
- if mimeType
is nullMethod Detail |
protected static final Class tryToLoadClass(String className, ClassLoader fallback) throws ClassNotFoundException
className
- the name of the class to be loadedfallback
- the fallback loader
ClassNotFoundException
- if class is not foundpublic String toString()
DataFlavor
and its
parameters. The resulting String
contains the name of
the DataFlavor
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. See selectBestTextFlavor
for a list of text flavors which support the charset parameter.
toString
in class Object
DataFlavor
selectBestTextFlavor(java.awt.datatransfer.DataFlavor[])
public static final DataFlavor getTextPlainUnicodeFlavor()
DataFlavor
representing plain text with Unicode
encoding, where:
representationClass = java.io.InputStream mimeType = "text/plain; charset=<platform default Unicode encoding>"Sun's implementation for Microsoft Windows use the encoding
utf-16le
.
Sun's implementation for Solaris and Linux use the encoding
iso-10646-ucs-2
.
DataFlavor
representing plain text
with Unicode encodingpublic static final DataFlavor selectBestTextFlavor(DataFlavor[] availableFlavors)
DataFlavor
from an array of
DataFlavor
s. Only DataFlavor.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:
For example, "text/sgml" will be selected over
"text/html", and DataFlavor.stringFlavor
will be chosen
over DataFlavor.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:
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 chosen
DataFlavor
, developers must ensure that all
DataFlavor
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.
availableFlavors
- an array of available DataFlavor
s
null
,
if availableFlavors
is null
,
has zero length, or contains no text flavorspublic Reader getReaderForText(Transferable transferable) throws UnsupportedFlavorException, IOException
java.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.
transferable
- the Transferable
whose data will be
requested in this flavor
Reader
to read the Transferable
's
data
IllegalArgumentException
- if the representation class
is not one of the seven listed above
IllegalArgumentException
- if the Transferable
has null
data
NullPointerException
- if the Transferable
is
null
UnsupportedEncodingException
- if this flavor's representation
is java.io.InputStream
,
java.nio.ByteBuffer
, or [B
and
this flavor's encoding is not supported by this
implementation of the Java platform
UnsupportedFlavorException
- if the Transferable
does not support this flavor
IOException
- if the data cannot be read because of an
I/O errorselectBestTextFlavor(java.awt.datatransfer.DataFlavor[])
public String getMimeType()
DataFlavor
.
public Class getRepresentationClass()
Class
which objects supporting this
DataFlavor
will return when this DataFlavor
is requested.
Class
which objects supporting this
DataFlavor
will return when this DataFlavor
is requestedpublic String getHumanPresentableName()
DataFlavor
represents. This name would be localized
for different countries.
DataFlavor
representspublic String getPrimaryType()
DataFlavor
.
DataFlavor
public String getSubType()
DataFlavor
.
DataFlavor
public String getParameter(String paramName)
DataFlavor
if paramName
equals "humanPresentableName". Otherwise
returns the MIME type value associated with paramName
.
paramName
- the parameter name requested
null
if there is no associated valueMimeType#getParameter()
public void setHumanPresentableName(String humanPresentableName)
DataFlavor
represents. This name would be localized
for different countries.
humanPresentableName
- the new human presentable namepublic boolean equals(Object o)
Object
to this DataFlavor
for equality. Two DataFlavor
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 not java.io.Reader
,
java.lang.String
, java.nio.CharBuffer
, or
[C
, the charset
parameter must also be equal.
If a charset is not explicitly specified for one or both
DataFlavor
s, the platform default encoding is assumed. See
selectBestTextFlavor
for a list of text flavors which
support the charset parameter.
equals
in class Object
o
- the Object
to compare with this
true
if that
is equivalent to this
DataFlavor
; false
otherwiseselectBestTextFlavor(java.awt.datatransfer.DataFlavor[])
public boolean equals(DataFlavor that)
DataFlavor
to this DataFlavor
for
equality. Two DataFlavor
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 not java.io.Reader
,
java.lang.String
, java.nio.CharBuffer
, or
[C
, the charset
parameter must also be equal.
If a charset is not explicitly specified for one or both
DataFlavor
s, the platform default encoding is assumed. See
selectBestTextFlavor
for a list of text flavors which
support the charset parameter.
that
- the DataFlavor
to compare with
this
true
if that
is equivalent to this
DataFlavor
; false
otherwiseselectBestTextFlavor(java.awt.datatransfer.DataFlavor[])
public boolean equals(String s)
hashCode()
contract,
use isMimeTypeEqual(String)
instead.
mimeType
against the passed in
String
and representationClass
is
not considered in the comparison.
If representationClass
needs to be compared, then
equals(new DataFlavor(s))
may be used.
public int hashCode()
DataFlavor
.
For two equal DataFlavor
s, hash codes are equal.
For the String
that matches DataFlavor.equals(String)
, it is not
guaranteed that DataFlavor
's hash code is equal
to the hash code of the String
.
hashCode
in class Object
DataFlavor
Object.equals(java.lang.Object)
,
Hashtable
public boolean match(DataFlavor that)
DataFlavor
to this DataFlavor
for
equality. Two DataFlavor
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 not java.io.Reader
,
java.lang.String
, java.nio.CharBuffer
, or
[C
, the charset
parameter must also be equal.
If a charset is not explicitly specified for one or both
DataFlavor
s, the platform default encoding is assumed. See
selectBestTextFlavor
for a list of text flavors which
support the charset parameter.
that
- the DataFlavor
to compare with
this
true
if that
is equivalent to this
DataFlavor
; false
otherwiseselectBestTextFlavor(java.awt.datatransfer.DataFlavor[])
public boolean isMimeTypeEqual(String mimeType)
DataFlavor
.
Parameters are not included in the comparison.
mimeType
- the string representation of the MIME type
DataFlavor
;
false otherwise
NullPointerException
- if mimeType is null
public final boolean isMimeTypeEqual(DataFlavor dataFlavor)
mimeType
of two DataFlavor
objects. No parameters are considered.
dataFlavor
- the DataFlavor
to be compared
MimeType
s are equal,
otherwise falsepublic boolean isMimeTypeSerializedObject()
DataFlavor
represent a serialized object?
public final Class getDefaultRepresentationClass()
public final String getDefaultRepresentationClassAsString()
public boolean isRepresentationClassInputStream()
DataFlavor
represent a
java.io.InputStream
?
public boolean isRepresentationClassReader()
DataFlavor
is java.io.Reader
or a subclass
thereof.
public boolean isRepresentationClassCharBuffer()
DataFlavor
is java.nio.CharBuffer
or a
subclass thereof.
public boolean isRepresentationClassByteBuffer()
DataFlavor
is java.nio.ByteBuffer
or a
subclass thereof.
public boolean isRepresentationClassSerializable()
public boolean isRepresentationClassRemote()
Remote
.
Remote
public boolean isFlavorSerializedObjectType()
DataFlavor
specified represents
a serialized object.
DataFlavor
specified represents
a Serialized Objectpublic boolean isFlavorRemoteObjectType()
DataFlavor
specified represents
a remote object.
DataFlavor
specified represents
a Remote Objectpublic boolean isFlavorJavaFileListType()
DataFlavor
specified represents
a list of file objects.
DataFlavor
specified represents
a List of File objectspublic boolean isFlavorTextType()
DataFlavor
is a valid text flavor for
this implementation of the Java platform. Only flavors equivalent to
DataFlavor.stringFlavor
and DataFlavor
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 be
java.io.Reader
, java.lang.String
,
java.nio.CharBuffer
, [C
,
java.io.InputStream
, java.nio.ByteBuffer
, or
[B
. If the representation is
java.io.InputStream
, java.nio.ByteBuffer
, or
[B
, then this flavor's charset
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.
true
if this DataFlavor
is a valid
text flavor as described above; false
otherwiseselectBestTextFlavor(java.awt.datatransfer.DataFlavor[])
public void writeExternal(ObjectOutput os) throws IOException
DataFlavor
.
writeExternal
in interface Externalizable
os
- the stream to write the object to
IOException
- Includes any I/O exceptions that may occurpublic void readExternal(ObjectInput is) throws IOException, ClassNotFoundException
DataFlavor
from a Serialized state.
readExternal
in interface Externalizable
is
- the stream to read data from in order to restore the object
IOException
- if I/O errors occur
ClassNotFoundException
- If the class for an object being
restored cannot be found.public Object clone() throws CloneNotSupportedException
DataFlavor
.
clone
in class Object
DataFlavor
CloneNotSupportedException
- if the object's class does not
support the Cloneable
interface. Subclasses
that override the clone
method can also
throw this exception to indicate that an instance cannot
be cloned.Cloneable
protected String normalizeMimeTypeParameter(String parameterName, String parameterValue)
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.
protected String normalizeMimeType(String mimeType)
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.
|
JavaTM 2 Platform Std. Ed. v1.4.2 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright 2003 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.