org.apache.axiom.attachments

Class PartContent

java.lang.Object

org.apache.axiom.attachments.PartContent

Direct Known Subclasses:

PartContentOnFile, PartContentOnMemory

abstract class PartContent
extends java.lang.Object

Stores the content of a MIME part using a particular buffering strategy.

Constructor Summary

Constructors

Constructor and Description
PartContent()

Method Summary

Modifier and Type	Method and Description
(package private) abstract void	destroy() Release all resources used to store the content of the MIME part.
(package private) abstract javax.activation.DataSource	getDataSource(java.lang.String contentType) Get a DataSource implementation specific for this buffering strategy, if supported.
(package private) abstract java.io.InputStream	getInputStream() Get an InputStream representing the buffered MIME part content.
(package private) abstract long	getSize() Get the size of the MIME part, more precisely the number of bytes in the decoded content of the MIME part.
(package private) abstract void	writeTo(java.io.OutputStream out) Write the buffered MIME part content to the given output stream.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PartContent

PartContent()

Method Detail

getInputStream

abstract java.io.InputStream getInputStream()
                                     throws java.io.IOException

Get an InputStream representing the buffered MIME part content. Note that a new InputStream object must be returned each time this method is called, and the stream must be positioned at the beginning of the data.

Returns:

the stream representing the content of this MIME part

Throws:

java.io.IOException - if an error occurs while accessing the buffered content

getDataSource

abstract javax.activation.DataSource getDataSource(java.lang.String contentType)

Get a DataSource implementation specific for this buffering strategy, if supported. If no DataSource is returned, then a default implementation will be used. If a DataSource is returned, it should implement SizeAwareDataSource.

Parameters:

contentType - the content type for the DataSource, which must be returned by DataSource.getContentType()

Returns:

the DataSource implementation or null if a default DataSource implementation should be used

writeTo

abstract void writeTo(java.io.OutputStream out)
               throws java.io.IOException

Write the buffered MIME part content to the given output stream. Note that the implementation must not consume the content, i.e. the content must still be available after this method completes.

Parameters:

out - the output stream to write the content to

Throws:

java.io.IOException - if an I/O error occurs (either while reading the buffered content or while writing to the output stream)

getSize

abstract long getSize()

Get the size of the MIME part, more precisely the number of bytes in the decoded content of the MIME part.

Returns:

the size of the MIME part

destroy

abstract void destroy()
               throws java.io.IOException

Release all resources used to store the content of the MIME part. The content will no longer be accessible after this method is called.

Throws:

java.io.IOException - if an I/O error occurs