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

Class AbstractVisitor

java.lang.Object

uk.ac.ed.epcc.webapp.AbstractContexed

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

All Implemented Interfaces:

Contexed, Visitor

Direct Known Subclasses:

ActionMessageVisitor, ContentMessageVisitor, DeDupVisitor, IsMessageVisitor, MimeStreamDataVisitor, PrefixVisitor

public class AbstractVisitor
extends AbstractContexed
implements Visitor

Implementation of the Visitor interface with default implementations of methods to make it easier to produce classes that implement the interface correctly. Essentially each method does nothing and all recursion is enabled

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EMAIL_EDIT_WRAP_THRESHOLD_CFG
static Feature	EMAIL_WRAP_FEATURE

Fields inherited from class uk.ac.ed.epcc.webapp.AbstractContexed

conn

Constructor Summary

Constructors

Constructor and Description
AbstractVisitor(AppContext conn)

Method Summary

Modifier and Type	Method and Description
protected java.lang.String	clean(java.lang.String text) normalise line breaks to newline
void	doBCC(Address[] cc, MessageWalker messageWalker) process all the BCC addresses This is called first then Visitor.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
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
protected java.lang.String	wrap(java.lang.String text)
protected java.lang.String	wrapForEdit(java.lang.String text)

Methods inherited from class uk.ac.ed.epcc.webapp.AbstractContexed

getContext, getLogger, resetLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.ed.epcc.webapp.editors.mail.Visitor

doReplyTo, doReplyTo, doSenders

Field Detail

EMAIL_EDIT_WRAP_THRESHOLD_CFG

public static final java.lang.String EMAIL_EDIT_WRAP_THRESHOLD_CFG

See Also:

Constant Field Values

EMAIL_WRAP_FEATURE

public static final Feature EMAIL_WRAP_FEATURE

Constructor Detail

AbstractVisitor

public AbstractVisitor(AppContext conn)

Parameters:

conn -

Method Detail

doCC

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

Description copied from interface: Visitor

process the CC fields

Specified by:

doCC in interface Visitor

Throws:

MessageWalker.WalkerException

doCC

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

Description copied from interface: Visitor

process a single CC field

Specified by:

doCC in interface Visitor

Throws:

MessageWalker.WalkerException

doBCC

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

Description copied from interface: Visitor

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

Specified by:

doBCC in interface Visitor

Throws:

MessageWalker.WalkerException

doBCC

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

Description copied from interface: Visitor

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

Specified by:

doBCC in interface Visitor

Throws:

MessageWalker.WalkerException

doFrom

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

Description copied from interface: Visitor

process the from fields

Specified by:

doFrom in interface Visitor

Throws:

MessageWalker.WalkerException

doHeader

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

Description copied from interface: Visitor

process an individual header field

Specified by:

doHeader in interface Visitor

Throws:

MessageWalker.WalkerException

doIOError

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

Description copied from interface: Visitor

method to handle exceptions when walking the message

Specified by:

doIOError in interface Visitor

Throws:

MessageWalker.WalkerException

doMessageError

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

Description copied from interface: Visitor

handle MessageExceptions while walking the message

Specified by:

doMessageError in interface Visitor

Throws:

MessageWalker.WalkerException

doRecipients

public void doRecipients(MessageWalker walker)
                  throws MessageWalker.WalkerException

Description copied from interface: Visitor

called immediatly after recipient fields are processed

Specified by:

doRecipients in interface Visitor

Throws:

MessageWalker.WalkerException

doSubject

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

Description copied from interface: Visitor

process the subject fields

Specified by:

doSubject in interface Visitor

Throws:

MessageWalker.WalkerException

doTo

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

Description copied from interface: Visitor

process the To fields

Specified by:

doTo in interface Visitor

Throws:

MessageWalker.WalkerException

doTo

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

Description copied from interface: Visitor

process an individual To field

Specified by:

doTo in interface Visitor

Throws:

MessageWalker.WalkerException

endMessage

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

Description copied from interface: Visitor

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

Specified by:

endMessage in interface Visitor

Throws:

MessageWalker.WalkerException

endMultiPart

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

Description copied from interface: Visitor

invoked at end of a multipart

Specified by:

endMultiPart in interface Visitor

Throws:

MessageWalker.WalkerException

endSubPart

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

Description copied from interface: Visitor

invoked at the end of each multipart

Specified by:

endSubPart in interface Visitor

Throws:

MessageWalker.WalkerException

startMessage

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

Description copied from interface: Visitor

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

Specified by:

startMessage in interface Visitor

Returns:

true if we are to recurse into the message

Throws:

MessageWalker.WalkerException

startMultiPart

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

Description copied from interface: Visitor

invoked at the start of a multipart

Specified by:

startMultiPart in interface Visitor

Returns:

true to recurse into multipart

Throws:

MessageWalker.WalkerException

startSubPart

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

Description copied from interface: Visitor

invoked at the start of each part in a multipart

Specified by:

startSubPart in interface Visitor

Returns:

true to recurse into part

Throws:

MessageWalker.WalkerException

visit

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

Description copied from interface: Visitor

visit a String part

Specified by:

visit in interface Visitor

Throws:

MessageWalker.WalkerException

visitInputStream

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

Description copied from interface: Visitor

visit a stream part

Specified by:

visitInputStream in interface Visitor

Throws:

MessageWalker.WalkerException

wrap

protected java.lang.String wrap(java.lang.String text)

clean

protected java.lang.String clean(java.lang.String text)

normalise line breaks to newline

Parameters:

text -

Returns:

wrapForEdit

protected java.lang.String wrapForEdit(java.lang.String text)

visitHeaders

public boolean visitHeaders()

Description copied from interface: Visitor

Does the visitor want to walker to visit the message headers

Specified by:

visitHeaders in interface Visitor

Returns:

boolean