|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.mailet.base.MatcherInverter
public class MatcherInverter
This class can be used as a wrapper for getting the "not matched" recipients
Constructor Summary | |
---|---|
MatcherInverter(Matcher wrappedMatcher)
|
Method Summary | |
---|---|
void |
destroy()
Destroys this Matcher. |
MatcherConfig |
getMatcherConfig()
Returns a MatcherConfig object, which provides initialization parameters and a MailetContext through which it can interact with the
mailet container. |
String |
getMatcherInfo()
Returns information about the matcher, such as author, version and copyright. |
void |
init(MatcherConfig config)
Initializes this Matcher. |
Collection<MailAddress> |
match(Mail mail)
Return a Collection of "not matched" recipients |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MatcherInverter(Matcher wrappedMatcher)
Method Detail |
---|
public void destroy()
Matcher
This method is called only once, after all Matcher.match(org.apache.mailet.Mail)
invocations
have completed (or a timeout period has elapsed). After this method
returns, this Matcher will no longer be used.
Implementations should use this method to release any resources that are being held (such as memory, file handles or threads) and make sure that any persistent information is properly stored.
Note that containers SHOULD NOT
invoke this method before
Matcher.init(MatcherConfig)
has been successfully completed.
destroy
in interface Matcher
Matcher.destroy()
public MatcherConfig getMatcherConfig()
Matcher
MailetContext
through which it can interact with the
mailet container.
Implementations of this interface are responsible for storing the
MatcherConfig which they receive in the Matcher.init(org.apache.mailet.MatcherConfig)
method so
that this method can return it.
getMatcherConfig
in interface Matcher
Matcher.getMatcherConfig()
public String getMatcherInfo()
Matcher
getMatcherInfo
in interface Matcher
Matcher.getMatcherInfo()
public void init(MatcherConfig config) throws javax.mail.MessagingException
Matcher
This method is called only once, and must complete successfully
before the Matcher.match(org.apache.mailet.Mail)
method can be invoked.
init
in interface Matcher
config
- a MatcherConfig containing the matcher's configuration
and initialization parameters
javax.mail.MessagingException
- if an error occursMatcher.destroy()
public Collection<MailAddress> match(Mail mail) throws javax.mail.MessagingException
match
in interface Matcher
mail
- the Mail to match
javax.mail.MessagingException
- if any error occurs which prevents the Mail
matching from completing successfully
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |