org.apache.axiom.ext.stax.datahandler

Interface DataHandlerProvider

All Known Implementing Classes:

TestCreateOMTextFromDataHandlerProvider.TestDataHandlerProvider, XOPDecodingStreamReader.DataHandlerProviderImpl

public interface DataHandlerProvider

Interface used for deferred loading of binary content.

See Also:

DataHandlerReader.isDeferred(), DataHandlerReader.getDataHandlerProvider()

Method Summary

Modifier and Type	Method and Description
javax.activation.DataHandler	getDataHandler() Get the DataHandler object for the binary content.
boolean	isLoaded() Check whether the DataHandler has already been loaded.

Method Detail

isLoaded

boolean isLoaded()

Check whether the DataHandler has already been loaded. A return value of true means that a call to getDataHandler() will not block or will retrieve the DataHandler without overhead. Note the return value of this method for a given instance of this class may change over time due to events other than a call to getDataHandler() on the same instance. E.g. a call to getDataHandler() on one instance may change the return value of the method on another instance (because the DataHandler objects can only be loaded in a certain sequence).

Returns:

true if the DataHandler has already been loaded; false otherwise

getDataHandler

javax.activation.DataHandler getDataHandler()
                                     throws java.io.IOException

Get the DataHandler object for the binary content.

Returns:

the binary content

Throws:

java.io.IOException - if an error occurs while loading the DataHandler