com.adaptris.util.text.mime

Class SelectByPosition

java.lang.Object

com.adaptris.util.text.mime.SelectByPosition

All Implemented Interfaces:

PartSelector

public class SelectByPosition
extends java.lang.Object
implements PartSelector

Selects a MimeBodyPart based on its position within the Multipart.

In the adapter configuration file this class is aliased as mime-select-by-position which is the preferred alternative to the fully qualified classname when building your configuration.

Constructor Summary

Constructors

Constructor and Description
SelectByPosition()
SelectByPosition(int i)

Method Summary

Modifier and Type	Method and Description
int	getPosition()
javax.mail.internet.MimeBodyPart	select(BodyPartIterator m) Select the body part that should form the AdaptrisMessage payload.
java.util.List<javax.mail.internet.MimeBodyPart>	select(javax.mail.internet.MimeMultipart in) Select the body part that should form the AdaptrisMessage payload.
void	setPosition(int i) The position of the MimeBodyPart to select within the multi part.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.adaptris.util.text.mime.PartSelector

select

Constructor Detail

SelectByPosition

public SelectByPosition()

SelectByPosition

public SelectByPosition(int i)

Method Detail

select

public javax.mail.internet.MimeBodyPart select(BodyPartIterator m)
                                        throws javax.mail.MessagingException

Description copied from interface: PartSelector

Select the body part that should form the AdaptrisMessage payload.

Specified by:

select in interface PartSelector

Returns:

the MimeBodyPart that should be the body, or null if no match found.

Throws:

javax.mail.MessagingException

select

public java.util.List<javax.mail.internet.MimeBodyPart> select(javax.mail.internet.MimeMultipart in)
                                                        throws javax.mail.MessagingException

Description copied from interface: PartSelector

Select the body part that should form the AdaptrisMessage payload.

Specified by:

select in interface PartSelector

Parameters:

in - a MimeMultipart

Returns:

a list of MimeBodyPart that should be the body, empty if no match found.

Throws:

javax.mail.MessagingException

getPosition

public int getPosition()

Returns:

the position

setPosition

public void setPosition(int i)

The position of the MimeBodyPart to select within the multi part.

Parameters:

i - the position to select, starting from 0