public final class FromTerm extends SearchTerm<java.lang.String>
Constructor and Description |
---|
FromTerm(java.lang.String pattern)
Initializes a new
FromTerm |
Modifier and Type | Method and Description |
---|---|
void |
accept(SearchTermVisitor visitor)
Handles given visitor for this search term.
|
void |
addMailField(java.util.Collection<MailField> col)
Adds the addressed MailField to specified collection
|
boolean |
containsWildcard()
Checks if this search term's pattern contains wildcard characters
'*' and '?' |
javax.mail.search.SearchTerm |
getJavaMailSearchTerm()
Generates the corresponding JavaMail instance of
SearchTerm from this search term |
javax.mail.search.SearchTerm |
getNonWildcardJavaMailSearchTerm()
Generates the corresponding instance of
SearchTerm from this search term without any wildcard characters. |
java.lang.String |
getPattern()
Gets the pattern to which the expression should match.
|
boolean |
isAscii()
Checks if this search term's pattern only consists of ASCII 7 bit characters.
|
boolean |
matches(MailMessage mailMessage)
Checks if specified mail message matches this search term
|
boolean |
matches(javax.mail.Message msg)
Checks if given message matches this search term
|
filter, filter
public FromTerm(java.lang.String pattern)
FromTerm
public void accept(SearchTermVisitor visitor)
SearchTerm
accept
in class SearchTerm<java.lang.String>
visitor
- The visitorpublic java.lang.String getPattern()
SearchTerm
getPattern
in class SearchTerm<java.lang.String>
public void addMailField(java.util.Collection<MailField> col)
SearchTerm
addMailField
in class SearchTerm<java.lang.String>
col
- The collection which gathers addressed fieldspublic boolean matches(MailMessage mailMessage)
SearchTerm
matches
in class SearchTerm<java.lang.String>
mailMessage
- The mail message to checktrue
if specified mail message matches this search term; otherwise false
public boolean matches(javax.mail.Message msg) throws com.openexchange.exception.OXException
SearchTerm
matches
in class SearchTerm<java.lang.String>
msg
- The message to checktrue
if message matches this search term; otherwise false
com.openexchange.exception.OXException
- If check failspublic javax.mail.search.SearchTerm getJavaMailSearchTerm()
SearchTerm
SearchTerm
from this search termgetJavaMailSearchTerm
in class SearchTerm<java.lang.String>
SearchTerm
public javax.mail.search.SearchTerm getNonWildcardJavaMailSearchTerm()
SearchTerm
SearchTerm
from this search term without any wildcard characters.
This is useful to preselect possible positives and to manually filtering out false positives.
getNonWildcardJavaMailSearchTerm
in class SearchTerm<java.lang.String>
SearchTerm
without any wildcard characters.SearchTerm.containsWildcard()
public boolean isAscii()
SearchTerm
This method implies that this search is some kind of string search term. Returns true
if not appropriate.
isAscii
in class SearchTerm<java.lang.String>
true
if search term's pattern only consists of ASCII 7 bit characters; otherwise false
public boolean containsWildcard()
SearchTerm
'*'
and '?'
.
This method implies that this search is some kind of string search term. Returns false
if not appropriate.
containsWildcard
in class SearchTerm<java.lang.String>
true
if this search term's pattern contains wildcard characters; otherwise false