Top Description Methods
jakarta.activation

public Interface DataContentHandler

Known Direct Implementers
jakarta.activation.DataSourceDataContentHandler, jakarta.activation.ObjectDataContentHandler
Imports
java.io.InputStream, .IOException, .OutputStream, jakarta.activation.DataSource

The DataContentHandler interface is implemented by objects that can be used to extend the capabilities of the DataHandler's implementation of the Transferable interface. Through DataContentHandlers the framework can be extended to convert streams in to objects, and to write objects to streams.

Applications don't generally call the methods in DataContentHandlers directly. Instead, an application calls the equivalent methods in DataHandler. The DataHandler will attempt to find an appropriate DataContentHandler that corresponds to its MIME type using the current DataContentHandlerFactory. The DataHandler then calls through to the methods in the DataContentHandler.

Method Summary

Modifier and TypeMethod and Description
public Object

Returns:

The constructed Object.
getContent
(DataSource
The DataSource representing the data to be converted.
ds
)

Return an object representing the data in its most preferred form.

public Object

Returns:

The constructed Object.
getTransferData
(ActivationDataFlavor
The ActivationDataFlavor representing the requested type.
df
,
DataSource
The DataSource representing the data to be converted.
ds
)

Returns an object which represents the data to be transferred.

public ActivationDataFlavor[]

Returns:

The ActivationDataFlavors.
getTransferDataFlavors
()

Returns an array of ActivationDataFlavor objects indicating the flavors the data can be provided in. The array should be ordered according to preference for providing the data (from most richly descriptive to least descriptive).

public void
writeTo(Object
The object to be converted.
obj
,
String
The requested MIME type of the resulting byte stream.
mimeType
,
OutputStream
The output stream into which to write the converted byte stream.
os
)

Convert the object to a byte stream of the specified MIME type and write it to the output stream.

Method Detail

getContentback to summary
public Object getContent(DataSource ds) throws IOException

Return an object representing the data in its most preferred form. Generally this will be the form described by the first ActivationDataFlavor returned by the getTransferDataFlavors method.

Parameters
ds:DataSource

The DataSource representing the data to be converted.

Returns:Object

The constructed Object.

Exceptions
IOException:
if the data can't be accessed
getTransferDataback to summary
public Object getTransferData(ActivationDataFlavor df, DataSource ds) throws IOException

Returns an object which represents the data to be transferred. The class of the object returned is defined by the representation class of the flavor.

Parameters
df:ActivationDataFlavor

The ActivationDataFlavor representing the requested type.

ds:DataSource

The DataSource representing the data to be converted.

Returns:Object

The constructed Object.

Exceptions
IOException:
  • if the handler doesn't support the requested flavor
  • if the data can't be accessed
getTransferDataFlavorsback to summary
public ActivationDataFlavor[] getTransferDataFlavors()

Returns an array of ActivationDataFlavor objects indicating the flavors the data can be provided in. The array should be ordered according to preference for providing the data (from most richly descriptive to least descriptive).

Returns:ActivationDataFlavor[]

The ActivationDataFlavors.

writeToback to summary
public void writeTo(Object obj, String mimeType, OutputStream os) throws IOException

Convert the object to a byte stream of the specified MIME type and write it to the output stream.

Parameters
obj:Object

The object to be converted.

mimeType:String

The requested MIME type of the resulting byte stream.

os:OutputStream

The output stream into which to write the converted byte stream.

Exceptions
IOException:
errors writing to the stream