uk.ac.ed.epcc.webapp.editors.mail

Interface Visitor

All Known Implementing Classes:

AbstractVisitor, ActionMessageVisitor, ContentMessageVisitor, DeDupVisitor, EditMessageVisitor, FlattenVisitor, FormContentEditMessageVisitor, IsMessageVisitor, MimeStreamDataVisitor, PrefixVisitor, QuoteVisitor, ShortContentMessageVisitor, TextEditHtmlMessageVisitor

public interface Visitor

Interface for classes that visit the parts of a message

Method Summary

Modifier and Type	Method and Description
void	doBCC(Address[] cc, MessageWalker messageWalker) process all the BCC addresses This is called first then doBCC(Address, int, int, MessageWalker) is called for each address.
void	doBCC(Address address, int i, int length, MessageWalker messageWalker) process a single BCC field.
void	doCC(Address[] cc, MessageWalker messageWalker) process the CC fields
void	doCC(Address address, int i, int length, MessageWalker messageWalker) process a single CC field
void	doFrom(java.lang.String[] from, MessageWalker messageWalker) process the from fields
void	doHeader(java.lang.String nextElement, MessageWalker messageWalker) process an individual header field
void	doIOError(MessageWalker w, java.io.IOException e) method to handle exceptions when walking the message
void	doMessageError(MessageWalker w, MessagingException e) handle MessageExceptions while walking the message
void	doRecipients(MessageWalker walker) called immediatly after recipient fields are processed
default void	doReplyTo(Address[] cc, MessageWalker messageWalker) process all the ReplyTo addresses This is called first then doReplyTo(Address, int, int, MessageWalker) is called for each address.
default void	doReplyTo(Address address, int i, int length, MessageWalker messageWalker) process a single ReplyTo field.
default void	doSenders(MessageWalker walker) called immediatly after sender fields are processed
void	doSubject(java.lang.String subject, MessageWalker messageWalker) process the subject fields
void	doTo(Address[] to, MessageWalker messageWalker) process the To fields
void	doTo(Address address, int i, int length, MessageWalker messageWalker) process an individual To field
void	endMessage(MimePart parent, MimeMessage m, MessageWalker messageWalker) invoked as we leave a message The messageWalker message level is set for the message we are leaving
void	endMultiPart(MimePart parent, MimeMultipart mp, MessageWalker messageWalker) invoked at end of a multipart
void	endSubPart(MimePart parent, MimeMultipart mp, MessageWalker messageWalker, int i, int count) invoked at the end of each multipart
boolean	startMessage(MimePart parent, MimeMessage m, MessageWalker messageWalker) invoked at the start of a message The messageWalker message level is set for the message we are entering.
boolean	startMultiPart(MimePart parent, MimeMultipart mp, MessageWalker messageWalker) invoked at the start of a multipart
boolean	startSubPart(MimePart parent, MimeMultipart mp, MessageWalker messageWalker, int i, int count) invoked at the start of each part in a multipart
void	visit(MimePart parent, java.lang.String content, MessageWalker messageWalker) visit a String part
boolean	visitHeaders() Does the visitor want to walker to visit the message headers
void	visitInputStream(MimePart parent, java.io.InputStream content, MessageWalker messageWalker) visit a stream part

Method Detail

startMessage

boolean startMessage(MimePart parent,
                     MimeMessage m,
                     MessageWalker messageWalker)
              throws MessageWalker.WalkerException

invoked at the start of a message The messageWalker message level is set for the message we are entering.

Parameters:

parent -

m -

messageWalker -

Returns:

true if we are to recurse into the message

Throws:

MessageWalker.WalkerException

endMessage

void endMessage(MimePart parent,
                MimeMessage m,
                MessageWalker messageWalker)
         throws MessageWalker.WalkerException

invoked as we leave a message The messageWalker message level is set for the message we are leaving

Parameters:

parent -

m -

messageWalker -

Throws:

MessageWalker.WalkerException

doIOError

void doIOError(MessageWalker w,
               java.io.IOException e)
        throws MessageWalker.WalkerException

method to handle exceptions when walking the message

Parameters:

w -

e -

Throws:

MessageWalker.WalkerException

doMessageError

void doMessageError(MessageWalker w,
                    MessagingException e)
             throws MessageWalker.WalkerException

handle MessageExceptions while walking the message

Parameters:

w -

e -

Throws:

MessageWalker.WalkerException

visit

void visit(MimePart parent,
           java.lang.String content,
           MessageWalker messageWalker)
    throws MessageWalker.WalkerException

visit a String part

Parameters:

parent -

content -

messageWalker -

Throws:

MessageWalker.WalkerException

visitInputStream

void visitInputStream(MimePart parent,
                      java.io.InputStream content,
                      MessageWalker messageWalker)
               throws MessageWalker.WalkerException

visit a stream part

Parameters:

parent -

content -

messageWalker -

Throws:

MessageWalker.WalkerException

startMultiPart

boolean startMultiPart(MimePart parent,
                       MimeMultipart mp,
                       MessageWalker messageWalker)
                throws MessageWalker.WalkerException

invoked at the start of a multipart

Parameters:

parent -

mp -

messageWalker -

Returns:

true to recurse into multipart

Throws:

MessageWalker.WalkerException

endMultiPart

void endMultiPart(MimePart parent,
                  MimeMultipart mp,
                  MessageWalker messageWalker)
           throws MessageWalker.WalkerException

invoked at end of a multipart

Parameters:

parent -

mp -

messageWalker -

Throws:

MessageWalker.WalkerException

startSubPart

boolean startSubPart(MimePart parent,
                     MimeMultipart mp,
                     MessageWalker messageWalker,
                     int i,
                     int count)
              throws MessageWalker.WalkerException

invoked at the start of each part in a multipart

Parameters:

parent -

mp -

messageWalker -

i -

count -

Returns:

true to recurse into part

Throws:

MessageWalker.WalkerException

endSubPart

void endSubPart(MimePart parent,
                MimeMultipart mp,
                MessageWalker messageWalker,
                int i,
                int count)
         throws MessageWalker.WalkerException

invoked at the end of each multipart

Parameters:

parent -

mp -

messageWalker -

i -

count -

Throws:

MessageWalker.WalkerException

doTo

void doTo(Address[] to,
          MessageWalker messageWalker)
   throws MessageWalker.WalkerException

process the To fields

Parameters:

to -

messageWalker -

Throws:

MessageWalker.WalkerException

doTo

void doTo(Address address,
          int i,
          int length,
          MessageWalker messageWalker)
   throws MessageWalker.WalkerException

process an individual To field

Parameters:

address -

i -

length -

messageWalker -

Throws:

MessageWalker.WalkerException

doCC

void doCC(Address[] cc,
          MessageWalker messageWalker)
   throws MessageWalker.WalkerException

process the CC fields

Parameters:

cc -

messageWalker -

Throws:

MessageWalker.WalkerException

doCC

void doCC(Address address,
          int i,
          int length,
          MessageWalker messageWalker)
   throws MessageWalker.WalkerException

process a single CC field

Parameters:

address -

i -

length -

messageWalker -

Throws:

MessageWalker.WalkerException

doBCC

void doBCC(Address[] cc,
           MessageWalker messageWalker)
    throws MessageWalker.WalkerException

process all the BCC addresses This is called first then doBCC(Address, int, int, MessageWalker) is called for each address.

Parameters:

cc -

messageWalker -

Throws:

MessageWalker.WalkerException

doBCC

void doBCC(Address address,
           int i,
           int length,
           MessageWalker messageWalker)
    throws MessageWalker.WalkerException

process a single BCC field. These are called in turn after the call to doBCC(Address[], MessageWalker)

Parameters:

address -

i -

length -

messageWalker -

Throws:

MessageWalker.WalkerException

doReplyTo

default void doReplyTo(Address[] cc,
                       MessageWalker messageWalker)
                throws MessageWalker.WalkerException

process all the ReplyTo addresses This is called first then doReplyTo(Address, int, int, MessageWalker) is called for each address.

Parameters:

cc -

messageWalker -

Throws:

MessageWalker.WalkerException

doReplyTo

default void doReplyTo(Address address,
                       int i,
                       int length,
                       MessageWalker messageWalker)
                throws MessageWalker.WalkerException

process a single ReplyTo field. These are called in turn after the call to doReplyTo(Address[], MessageWalker)

Parameters:

address -

i -

length -

messageWalker -

Throws:

MessageWalker.WalkerException

doSubject

void doSubject(java.lang.String subject,
               MessageWalker messageWalker)
        throws MessageWalker.WalkerException

process the subject fields

Parameters:

subject -

messageWalker -

Throws:

MessageWalker.WalkerException

doFrom

void doFrom(java.lang.String[] from,
            MessageWalker messageWalker)
     throws MessageWalker.WalkerException

process the from fields

Parameters:

from -

messageWalker -

Throws:

MessageWalker.WalkerException

doHeader

void doHeader(java.lang.String nextElement,
              MessageWalker messageWalker)
       throws MessageWalker.WalkerException

process an individual header field

Parameters:

nextElement -

messageWalker -

Throws:

MessageWalker.WalkerException

doRecipients

void doRecipients(MessageWalker walker)
           throws MessageWalker.WalkerException

called immediatly after recipient fields are processed

Parameters:

walker -

Throws:

MessageWalker.WalkerException

doSenders

default void doSenders(MessageWalker walker)
                throws MessageWalker.WalkerException

called immediatly after sender fields are processed

Parameters:

walker -

Throws:

MessageWalker.WalkerException

visitHeaders

boolean visitHeaders()

Does the visitor want to walker to visit the message headers

Returns:

boolean