Class StorageTextBody

java.lang.Object

org.apache.james.mime4j.dom.SingleBody

org.apache.james.mime4j.dom.TextBody

org.apache.james.mime4j.storage.StorageTextBody

All Implemented Interfaces:

Body, Disposable

class StorageTextBody
extends TextBody

Text body backed by a Storage.

Field Summary

Fields

Modifier and Type	Field	Description
private final Charset	charset
private MultiReferenceStorage	storage

Constructor Summary

Constructors

Constructor	Description
StorageTextBody(MultiReferenceStorage storage, Charset charset)

Method Summary

Modifier and Type	Method	Description
StorageTextBody	copy()	Returns a copy of this SingleBody (optional operation).
void	dispose()	Deletes the Storage that holds the content of this text body.
Charset	getCharset()
InputStream	getInputStream()	Gets a InputStream which reads the bytes of the body.
String	getMimeCharset()	Returns the MIME charset of this text body.
Reader	getReader()	Gets a Reader which may be used to read out the contents of this body.

Methods inherited from class SingleBody

getParent, setParent, size, writeTo

Methods inherited from class Object

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

Field Details

storage

private MultiReferenceStorage storage

charset

private final Charset charset

Constructor Details

StorageTextBody

public StorageTextBody(MultiReferenceStorage storage,
 Charset charset)

Method Details

getMimeCharset

public String getMimeCharset()

Description copied from class: TextBody

Returns the MIME charset of this text body.

Specified by:

getMimeCharset in class TextBody

Returns:

the MIME charset.

getCharset

public Charset getCharset()

Specified by:

getCharset in class TextBody

getReader

public Reader getReader()
                 throws IOException

Description copied from class: TextBody

Gets a Reader which may be used to read out the contents of this body.

Specified by:

getReader in class TextBody

Returns:

the Reader.

Throws:

IOException - on I/O errors.

getInputStream

public InputStream getInputStream()
                           throws IOException

Description copied from class: SingleBody

Gets a InputStream which reads the bytes of the body.

Specified by:

getInputStream in class SingleBody

Returns:

the stream, transfer decoded

Throws:

IOException - on I/O errors.

copy

public StorageTextBody copy()

Description copied from class: SingleBody

Returns a copy of this SingleBody (optional operation).

The general contract of this method is as follows:

• Invoking SingleBody.getParent() on the copy returns null. That means that the copy is detached from the parent entity of this SingleBody. The copy may get attached to a different entity later on.
• The underlying content does not have to be copied. Instead it may be shared between multiple copies of a SingleBody.
• If the underlying content is shared by multiple copies the implementation has to make sure that the content gets deleted when the last copy gets disposed of (and not before that).

This implementation always throws an UnsupportedOperationException.

Overrides:

copy in class SingleBody

Returns:

a copy of this SingleBody.

dispose

public void dispose()

Deletes the Storage that holds the content of this text body.

Specified by:

dispose in interface Disposable

Overrides:

dispose in class SingleBody

See Also:

• Disposable.dispose()