| public class javax.activation DataHandler
|
Java SE 6 |
DataHandler and the Transferable Interface
DataHandler implements the Transferable interface so that data can be used in AWT data transfer operations, such as cut and paste and drag and drop. The implementation of the Transferable interface relies on the availability of an installed DataContentHandler object corresponding to the MIME type of the data represented in the specific instance of the DataHandler.
DataHandler and CommandMaps
The DataHandler keeps track of the current CommandMap that it uses to
service requests for commands (getCommand,
getAllCommands, getPreferredCommands).
Each instance of a DataHandler may have a CommandMap associated with
it using the setCommandMap method. If a CommandMap was
not set, DataHandler calls the getDefaultCommandMap
method in CommandMap and uses the value it returns. See
CommandMap for more information.
DataHandler and URLs
The current DataHandler implementation creates a private instance of URLDataSource when it is constructed with a URL.
| since | 1.6 |
| See also | javax.activation.CommandMap, javax.activation.DataContentHandler, javax.activation.DataSource, javax.activation.URLDataSource |
| Constructors | |||||
|---|---|---|---|---|---|
| public | DataHandler(DataSource ds) Details
Create a DataHandler instance referencing the
specified DataSource. The data exists in a byte stream form.
The DataSource will provide an InputStream to access the data.
| ||||
| public | DataHandler(Object obj, String mimeType) Details
Create a DataHandler instance representing an object
of this MIME type. This constructor is
used when the application already has an in-memory representation
of the data in the form of a Java Object.
| ||||
| public | DataHandler(URL url) Details
Create a DataHandler instance referencing a URL.
The DataHandler internally creates a URLDataSource
instance to represent the URL.
| ||||
| Methods | |||||
|---|---|---|---|---|---|
| public void | writeTo(OutputStream os) throws IOException Details
Write the data to an OutputStream.If the DataHandler was created with a DataSource, writeTo retrieves the InputStream and copies the bytes from the InputStream to the OutputStream passed in.
If the DataHandler was created with an object, writeTo
retrieves the DataContentHandler for the object's type.
If the DataContentHandler was found, it calls the
| ||||
| Properties | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| public CommandInfo[] | getAllCommands() Details
Return all the commands for this type of data.
This method returns an array containing all commands
for the type of data represented by this DataHandler. The
MIME type for the underlying data represented by this DataHandler
is used to call through to the getAllCommands method
of the CommandMap associated with this DataHandler.
| ||||||||||
| public Object | getBean(CommandInfo cmdinfo) Details
A convenience method that takes a CommandInfo object
and instantiates the corresponding command, usually
a JavaBean component.
This method calls the CommandInfo's
| ||||||||||
| public CommandInfo | getCommand(String cmdName) Details
Get the command cmdName. Use the search semantics as
defined by the CommandMap installed in this DataHandler. The
MIME type for the underlying data represented by this DataHandler
is used to call through to the getCommand method
of the CommandMap associated with this DataHandler.
| ||||||||||
| public void | setCommandMap(CommandMap commandMap) Details
Set the CommandMap for use by this DataHandler.
Setting it to null causes the CommandMap to revert
to the CommandMap returned by the
CommandMap.getDefaultCommandMap method.
Changing the CommandMap, or setting it to null,
clears out any data cached from the previous CommandMap.
| ||||||||||
| public Object | getContent() throws IOException Details
Return the data in its preferred Object form. If the DataHandler was instantiated with an object, return the object.
If the DataHandler was instantiated with a DataSource,
this method uses a DataContentHandler to return the content
object for the data represented by this DataHandler. If no
| ||||||||||
| public String | getContentType() Details
Return the MIME type of this object as retrieved from
the source object. Note that this is the full
type with parameters.
| ||||||||||
| public static void | setDataContentHandlerFactory(DataContentHandlerFactory newFactory) Details
Sets the DataContentHandlerFactory. The DataContentHandlerFactory
is called first to find DataContentHandlers.
The DataContentHandlerFactory can only be set once.
If the DataContentHandlerFactory has already been set, this method throws an Error.
| ||||||||||
| public boolean | isDataFlavorSupported(DataFlavor flavor) Details
Returns whether the specified data flavor is supported
for this object.
This method iterates through the DataFlavors returned from
| ||||||||||
| public DataSource | getDataSource() Details
Return the DataSource associated with this instance
of DataHandler.
For DataHandlers that have been instantiated with a DataSource, this method returns the DataSource that was used to create the DataHandler object. In other cases the DataHandler constructs a DataSource from the data used to construct the DataHandler. DataSources created for DataHandlers not instantiated with a DataSource are cached for performance reasons.
| ||||||||||
| public InputStream | getInputStream() throws IOException Details
Get the InputStream for this object.
For DataHandlers instantiated with a DataSource, the DataHandler
calls the
For DataHandlers instantiated with an Object, the DataHandler
first attempts to find a DataContentHandler for the Object. If
the DataHandler can not find a DataContentHandler for this MIME
type, it throws an UnsupportedDataTypeException. If it is
successful, it creates a pipe and a thread. The thread uses the
DataContentHandler's
| ||||||||||
| public String | getName() Details
Return the name of the data object. If this DataHandler
was created with a DataSource, this method calls through
to the DataSource.getName method, otherwise it
returns null.
| ||||||||||
| public OutputStream | getOutputStream() throws IOException Details
Get an OutputStream for this DataHandler to allow overwriting
the underlying data.
If the DataHandler was created with a DataSource, the
DataSource's getOutputStream method is called.
Otherwise, null is returned.
| ||||||||||
| public CommandInfo[] | getPreferredCommands() Details
Return the preferred commands for this type of data.
This method calls the getPreferredCommands method
in the CommandMap associated with this instance of DataHandler.
This method returns an array that represents a subset of
available commands. In cases where multiple commands for the
MIME type represented by this DataHandler are present, the
installed CommandMap chooses the appropriate commands.
| ||||||||||
| public Object | getTransferData(DataFlavor flavor) throws UnsupportedFlavorException, IOException Details
Returns an object that represents the data to be
transferred. The class of the object returned is defined by the
representation class of the data flavor. For DataHandler's created with DataSources or URLs:
The DataHandler attempts to locate a DataContentHandler
for this MIME type. If one is found, the passed in DataFlavor
and the type of the data are passed to its For DataHandler's created with Objects: The DataHandler attempts to locate a DataContentHandler for this MIME type. If one is found, the passed in DataFlavor and the type of the data are passed to its getTransferData method. If the DataHandler fails to locate a DataContentHandler and the flavor specifies this object's MIME type and its class, this DataHandler's referenced object is returned. Otherwise it throws an UnsupportedFlavorException.
| ||||||||||
| public DataFlavor[] | getTransferDataFlavors() Details
Return the DataFlavors in which this data is available. Returns an array of DataFlavor objects indicating the flavors the data can be provided in. The array is usually ordered according to preference for providing the data, from most richly descriptive to least richly descriptive.
The DataHandler attempts to find a DataContentHandler that
corresponds to the MIME type of the data. If one is located,
the DataHandler calls the DataContentHandler's
If a DataContentHandler can not be located, and if the
DataHandler was created with a DataSource (or URL), one
DataFlavor is returned that represents this object's MIME type
and the
| ||||||||||
| About DocWeb · Bundles · Export · Export All | Top 10 · Statistics · Login |
| About Sun · Contact · Privacy · Terms of Use · Trademarks | Java SE 6 · Copyright © 1994-2013 Sun Microsystems, Inc.All rights reserved. Use is subject to license terms |
![]() |
![]() |
|