Package org.apache.james.mime4j.dom
Interface Entity
- All Superinterfaces:
Disposable
- All Known Subinterfaces:
Message
- All Known Implementing Classes:
AbstractEntity
,AbstractMessage
,BodyPart
,MessageImpl
A MIME entity. An entity has a header and a body (as defined in RFC 2045).
-
Method Summary
Modifier and TypeMethodDescriptiongetBody()
Gets the body of this entity.Determines the MIME character set encoding of thisEntity
.Determines the transfer encoding of thisEntity
.Return the disposition type of the content disposition of thisEntity
.Returns the filename parameter of the content disposition of thisEntity
.Gets the entity header.Determines the MIME type of thisEntity
.Gets the parent entity of this entity.boolean
Determines if the MIME type of thisEntity
ismultipart/*
.Removes and returns the body of this entity.void
Sets the body of this entity.void
Sets the entity header.void
Sets the parent entity of this entity.Methods inherited from interface org.apache.james.mime4j.dom.Disposable
dispose
-
Method Details
-
getParent
Entity getParent()Gets the parent entity of this entity. Returnsnull
if this is the root entity.- Returns:
- the parent or
null
.
-
setParent
Sets the parent entity of this entity.- Parameters:
parent
- the parent entity ornull
if this will be the root entity.
-
getHeader
Header getHeader()Gets the entity header.- Returns:
- the header.
-
setHeader
Sets the entity header.- Parameters:
header
- the header.
-
getBody
Body getBody()Gets the body of this entity.- Returns:
- the body,
-
setBody
Sets the body of this entity.- Parameters:
body
- the body.- Throws:
IllegalStateException
- if the body has already been set.
-
removeBody
Body removeBody()Removes and returns the body of this entity. The removed body may be attached to another entity. If it is no longer needed it should bedisposed
of.- Returns:
- the removed body or
null
if no body was set.
-
isMultipart
boolean isMultipart()Determines if the MIME type of thisEntity
ismultipart/*
. Since multipart-entities must have a boundary parameter in theContent-Type
field this method returnsfalse
if no boundary exists.- Returns:
true
on match,false
otherwise.
-
getMimeType
String getMimeType()Determines the MIME type of thisEntity
. The MIME type is derived by looking at the parent's Content-Type field if no Content-Type field is set for thisEntity
.- Returns:
- the MIME type.
-
getCharset
String getCharset()Determines the MIME character set encoding of thisEntity
.- Returns:
- the MIME character set encoding.
-
getContentTransferEncoding
String getContentTransferEncoding()Determines the transfer encoding of thisEntity
.- Returns:
- the transfer encoding.
-
getDispositionType
String getDispositionType()Return the disposition type of the content disposition of thisEntity
.- Returns:
- the disposition type or
null
if no disposition type has been set.
-
getFilename
String getFilename()Returns the filename parameter of the content disposition of thisEntity
.- Returns:
- the filename parameter of the content disposition or
null
if the filename has not been set.
-