org.exist.xmldb
Interface ExtendedResource

All Known Implementing Classes:

AbstractRemoteResource, LocalBinaryResource, RemoteBinaryResource, RemoteXMLResource

public interface ExtendedResource

An extension to BinaryResource interface, which adds the common methods needed by LocalBinaryResource and RemoteBinaryResource, so they can be streamlined.

Author:

jmfernandez

Method Summary

void	freeLocalResources() It erases the internal reference to any file set with getContentIntoAFile, either explicitly or implicitly using, for instance, getStreamContent.
void	getContentIntoAFile(File localfile) It saves the resource to the local file given as input parameter.
void	getContentIntoAStream(OutputStream os) It saves the resource to the local stream given as input parameter.
Object	getExtendedContent() It returns an object representing the content, in the representation which needs less memory.
InputStream	getStreamContent() It returns an stream to the content, whichever it is its origin
long	getStreamLength() It returns the length of the content, whichever it is its origin

Method Detail

getExtendedContent

Object getExtendedContent()
                          throws org.xmldb.api.base.XMLDBException

It returns an object representing the content, in the representation which needs less memory.

Throws:

org.xmldb.api.base.XMLDBException

getStreamContent

InputStream getStreamContent()
                             throws org.xmldb.api.base.XMLDBException

It returns an stream to the content, whichever it is its origin

Throws:

org.xmldb.api.base.XMLDBException

getStreamLength

long getStreamLength()
                     throws org.xmldb.api.base.XMLDBException

It returns the length of the content, whichever it is its origin

Throws:

org.xmldb.api.base.XMLDBException

getContentIntoAFile

void getContentIntoAFile(File localfile)
                         throws org.xmldb.api.base.XMLDBException

It saves the resource to the local file given as input parameter. Do NOT confuse with set content.

Throws:

org.xmldb.api.base.XMLDBException

getContentIntoAStream

void getContentIntoAStream(OutputStream os)
                           throws org.xmldb.api.base.XMLDBException

It saves the resource to the local stream given as input parameter. Do NOT confuse with set content.

Throws:

org.xmldb.api.base.XMLDBException

freeLocalResources

void freeLocalResources()

It erases the internal reference to any file set with getContentIntoAFile, either explicitly or implicitly using, for instance, getStreamContent.