This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.
javax.mail.search
class RecipientStringTerm
- All Implemented Interfaces:
- Serializable
public final class RecipientStringTerm
extends AddressStringTerm
This class implements string comparisons for the Recipient Address
headers.
Note that this class differs from the RecipientTerm
class
in that this class does comparisons on address strings rather than Address
objects. The string comparisons are case-insensitive.
- See Also (auto-generated):
-
Message
Session
Multipart
Constructor Summary |
Constructor.
|
Method Summary |
boolean |
Equality comparison.
|
Message.RecipientType |
Return the type of recipient to match with.
|
int |
Compute a hashCode for this object.
|
boolean |
Check whether the address specified in the constructor is
a substring of the recipient address of this Message.
|
RecipientStringTerm
public RecipientStringTerm(Message.RecipientType type,
String pattern)
-
Constructor.
- Parameters:
type
- the recipient type
pattern
- the address pattern to be compared.
equals
public boolean equals(Object obj)
-
Equality comparison.
- Overrides:
equals
in class AddressStringTerm
- Parameters:
obj
getRecipientType
public Message.RecipientType getRecipientType()
-
Return the type of recipient to match with.
hashCode
public int hashCode()
-
Compute a hashCode for this object.
- Overrides:
hashCode
in class StringTerm
match
public boolean match(Message msg)
-
Check whether the address specified in the constructor is
a substring of the recipient address of this Message.
- Overrides:
match
in class SearchTerm
- Parameters:
msg
- The comparison is applied to this Message's recipient
address.
- Returns:
- true if the match succeeds, otherwise false.
This documentation differs from the official API.
Jadeite adds
extra features to the API including:
variable font sizes,
constructions examples,
placeholders for classes and methods, and auto-generated “See Also” links.
Additionally it
is missing some items found in standard Javadoc documentation, including:
generics type information,
“Deprecated” tags and comments,
“See Also” links,
along with other minor differences.
Please send any questions or feedback to
bam@cs.cmu.edu.