org.apache.james.imap.encode.base

Class AbstractChainedImapEncoder

java.lang.Object

org.apache.james.imap.encode.base.AbstractChainedImapEncoder

All Implemented Interfaces:

ImapEncoder

Direct Known Subclasses:

ACLResponseEncoder, AuthenticateResponseEncoder, CapabilityResponseEncoder, ContinuationResponseEncoder, EnableResponseEncoder, ESearchResponseEncoder, ExistsResponseEncoder, ExpungeResponseEncoder, FetchResponseEncoder, FlagsResponseEncoder, ListResponseEncoder, LSubResponseEncoder, MailboxStatusResponseEncoder, NamespaceResponseEncoder, RecentResponseEncoder, SearchResponseEncoder, StatusResponseEncoder, VanishedResponseEncoder, XListResponseEncoder

public abstract class AbstractChainedImapEncoder
extends Object
implements ImapEncoder

Abstract base class for chained ImapEncoder implementations. Implementations of this will check if the ImapMessage should get encoded by this Implementation or should get passed to the next ImapEncoder in the chain

Constructor Summary

Constructors

Constructor and Description
AbstractChainedImapEncoder(ImapEncoder next)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	chainEncode(ImapMessage message, ImapResponseComposer composer, ImapSession session) Call next Encoder in the chain
protected abstract void	doEncode(ImapMessage acceptableMessage, ImapResponseComposer composer, ImapSession session) Processes an acceptable message.
void	encode(ImapMessage message, ImapResponseComposer composer, ImapSession session) Encode the ImapMessage if isAcceptable(ImapMessage) return true, if not pass it to the next encoder in the chain
protected abstract boolean	isAcceptable(ImapMessage message) Is the given message acceptable?

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractChainedImapEncoder

public AbstractChainedImapEncoder(ImapEncoder next)

Method Detail

encode

public void encode(ImapMessage message,
          ImapResponseComposer composer,
          ImapSession session)
            throws IOException

Encode the ImapMessage if isAcceptable(ImapMessage) return true, if not pass it to the next encoder in the chain

Specified by:

encode in interface ImapEncoder

Parameters:

message - ImapMessage, not null

composer - ImapResponseComposer, not null

session - TODO

Throws:

IOException - when message encoding fails

chainEncode

protected void chainEncode(ImapMessage message,
               ImapResponseComposer composer,
               ImapSession session)
                    throws IOException

Call next Encoder in the chain

Parameters:

message -

composer -

session -

Throws:

IOException

isAcceptable

protected abstract boolean isAcceptable(ImapMessage message)

Is the given message acceptable?

Parameters:

message - ImapMessage, not null

Returns:

true if the given message is encodable by this encoder

doEncode

protected abstract void doEncode(ImapMessage acceptableMessage,
            ImapResponseComposer composer,
            ImapSession session)
                          throws IOException

Processes an acceptable message. Only messages passing isAcceptable(ImapMessage) should be passed to this method.

Parameters:

acceptableMessage - ImapMessage, not null

composer - ImapResponseComposer, not null

session - TODO

Throws:

IOException