Package 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 aString
.
-
-
Constructor Summary
Constructors Constructor Description StringTextBody(java.lang.String text, java.nio.charset.Charset charset)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringTextBody
copy()
Returns a copy of thisSingleBody
(optional operation).java.nio.charset.Charset
getCharset()
java.io.InputStream
getInputStream()
Gets aInputStream
which reads the bytes of the body.java.lang.String
getMimeCharset()
Returns the MIME charset of this text body.java.io.Reader
getReader()
Gets aReader
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, size
-
-
-
-
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 classTextBody
- Returns:
- the MIME charset.
-
getCharset
public java.nio.charset.Charset getCharset()
- Specified by:
getCharset
in classTextBody
-
getInputStream
public java.io.InputStream getInputStream() throws java.io.IOException
Description copied from class:SingleBody
Gets aInputStream
which reads the bytes of the body.- Specified by:
getInputStream
in classSingleBody
- 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 aReader
which may be used to read out the contents of this body.
-
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 bySingleBody.getInputStream()
to the specified output stream. May be overwritten by a subclass to improve performance.- Overrides:
writeTo
in classSingleBody
- 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 thisSingleBody
(optional operation).The general contract of this method is as follows:
- Invoking
SingleBody.getParent()
on the copy returnsnull
. That means that the copy is detached from the parent entity of thisSingleBody
. 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 classSingleBody
- Returns:
- a copy of this
SingleBody
.
- Invoking
-
-