org.apache.james.mailbox.store.mail.model

Class AbstractMessage<Id>

java.lang.Object

org.apache.james.mailbox.store.mail.model.AbstractMessage<Id>

All Implemented Interfaces:

Comparable<Message<Id>>, Message<Id>

Direct Known Subclasses:

AbstractJPAMessage, HBaseMessage, JCRMessage, MaildirMessage, SimpleMessage

public abstract class AbstractMessage<Id>
extends Object
implements Message<Id>

Abstract base class for Message

Constructor Summary

Constructors

Constructor and Description
AbstractMessage()

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(Message<Id> other)
javax.mail.Flags	createFlags() Creates a new flags instance populated with the current flag data.
protected String[]	createUserFlags() Return all stored user flags or null if none are stored.
long	getBodyOctets() The number of octets contained in the body of this part.
protected abstract int	getBodyStartOctet() Return the start octet of the body
InputStream	getFullContent() This implementation just concat Message.getHeaderContent() and Message.getBodyContent().

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.james.mailbox.store.mail.model.Message

getBodyContent, getFullContentOctets, getHeaderContent, getInternalDate, getMailboxId, getMediaType, getModSeq, getProperties, getSubType, getTextualLineCount, getUid, isAnswered, isDeleted, isDraft, isFlagged, isRecent, isSeen, setFlags, setModSeq, setUid

Constructor Detail

AbstractMessage

public AbstractMessage()

Method Detail

compareTo

public int compareTo(Message<Id> other)

Specified by:

compareTo in interface Comparable<Message<Id>>

See Also:

Comparable.compareTo(java.lang.Object)

createFlags

public final javax.mail.Flags createFlags()

Description copied from interface: Message

Creates a new flags instance populated with the current flag data.

Specified by:

createFlags in interface Message<Id>

Returns:

new instance, not null

See Also:

Message.createFlags()

createUserFlags

protected String[] createUserFlags()

Return all stored user flags or null if none are stored. By default this return null as no user flags are stored permanent. This method SHOULD get overridden, If the implementation supports to store user flags.

Returns:

userFlags

getBodyOctets

public long getBodyOctets()

The number of octets contained in the body of this part.

Specified by:

getBodyOctets in interface Message<Id>

Returns:

number of octets

getBodyStartOctet

protected abstract int getBodyStartOctet()

Return the start octet of the body

Returns:

startOctet

getFullContent

public InputStream getFullContent()
                           throws IOException

This implementation just concat Message.getHeaderContent() and Message.getBodyContent(). Implementation should override this if they can provide a more performant solution

Specified by:

getFullContent in interface Message<Id>

Returns:

content

Throws:

exception

IOException