org.apache.james.mime4j.storage

Class StringTextBody

java.lang.Object

org.apache.james.mime4j.dom.SingleBody

org.apache.james.mime4j.dom.TextBody

org.apache.james.mime4j.storage.StringTextBody

All Implemented Interfaces:

Body, Disposable

class StringTextBody
extends TextBody

Text body backed by a String.

Field Summary

Fields

Modifier and Type	Field and Description
private java.nio.charset.Charset	charset
private java.lang.String	text

Constructor Summary

Constructors

Constructor and Description
StringTextBody(java.lang.String text, java.nio.charset.Charset charset)

Method Summary

Modifier and Type	Method and Description
StringTextBody	copy() Returns a copy of this SingleBody (optional operation).
java.io.InputStream	getInputStream() Gets a InputStream which reads the bytes of the body.
java.lang.String	getMimeCharset() Returns the MIME charset of this text body.
java.io.Reader	getReader() Gets a Reader which may be used to read out the contents of this body.
void	writeTo(java.io.OutputStream out) Writes this single body to the given stream.

Methods inherited from class org.apache.james.mime4j.dom.SingleBody

dispose, getParent, setParent

Methods inherited from class java.lang.Object

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

Field Detail

text

private final java.lang.String text

charset

private final java.nio.charset.Charset charset

Constructor Detail

StringTextBody

public StringTextBody(java.lang.String text,
                      java.nio.charset.Charset charset)

Method Detail

getMimeCharset

public java.lang.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.

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.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:

java.io.IOException - on I/O errors.

getReader

public java.io.Reader getReader()
                         throws java.io.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:

java.io.IOException - on I/O errors.

writeTo

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

Description copied from class: SingleBody

Writes this single body to the given stream. The default implementation copies the input stream obtained by SingleBody.getInputStream() to the specified output stream. May be overwritten by a subclass to improve performance.

Overrides:

writeTo in class SingleBody

Parameters:

out - the stream to write to.

Throws:

java.io.IOException - in case of an I/O error

copy

public StringTextBody 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.