1 /*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
3 *
4 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
5 *
6 * The contents of this file are subject to the terms of either the GNU
7 * General Public License Version 2 only ("GPL") or the Common Development
8 * and Distribution License("CDDL") (collectively, the "License"). You
9 * may not use this file except in compliance with the License. You can obtain
10 * a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html
11 * or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific
12 * language governing permissions and limitations under the License.
13 *
14 * When distributing the software, include this License Header Notice in each
15 * file and include the License file at glassfish/bootstrap/legal/LICENSE.txt.
16 * Sun designates this particular file as subject to the "Classpath" exception
17 * as provided by Sun in the GPL Version 2 section of the License file that
18 * accompanied this code. If applicable, add the following below the License
19 * Header, with the fields enclosed by brackets [] replaced by your own
20 * identifying information: "Portions Copyrighted [year]
21 * [name of copyright owner]"
22 *
23 * Contributor(s):
24 *
25 * If you wish your version of this file to be governed by only the CDDL or
26 * only the GPL Version 2, indicate your decision by adding "[Contributor]
27 * elects to include this software in this distribution under the [CDDL or GPL
28 * Version 2] license." If you don't indicate a single choice of license, a
29 * recipient has the option to distribute your version of this file under
30 * either the CDDL, the GPL Version 2 or to extend the choice of license to
31 * its licensees as provided above. However, if you add GPL Version 2 code
32 * and therefore, elected the GPL Version 2 license, then the option applies
33 * only if the new code is made subject to such option by the copyright
34 * holder.
35 */
36
37 /*
38 * @(#)RecipientStringTerm.java 1.10 07/05/04
39 */
40
41 package javax.mail.search;
42
43 import javax.mail.Message;
44 import javax.mail.Address;
45
46 /**
47 * This class implements string comparisons for the Recipient Address
48 * headers. <p>
49 *
50 * Note that this class differs from the <code>RecipientTerm</code> class
51 * in that this class does comparisons on address strings rather than Address
52 * objects. The string comparisons are case-insensitive.
53 *
54 * @since JavaMail 1.1
55 */
56
57 public final class RecipientStringTerm extends AddressStringTerm {
58
59 /**
60 * The recipient type.
61 *
62 * @serial
63 */
64 private Message.RecipientType type;
65
66 private static final long serialVersionUID = -8293562089611618849L;
67
68 /**
69 * Constructor.
70 *
71 * @param type the recipient type
72 * @param pattern the address pattern to be compared.
73 */
74 public RecipientStringTerm(Message.RecipientType type, String pattern) {
75 super(pattern);
76 this.type = type;
77 }
78
79 /**
80 * Return the type of recipient to match with.
81 */
82 public Message.RecipientType getRecipientType() {
83 return type;
84 }
85
86 /**
87 * Check whether the address specified in the constructor is
88 * a substring of the recipient address of this Message.
89 *
90 * @param msg The comparison is applied to this Message's recipient
91 * address.
92 * @return true if the match succeeds, otherwise false.
93 */
94 public boolean match(Message msg) {
95 Address[] recipients;
96
97 try {
98 recipients = msg.getRecipients(type);
99 } catch (Exception e) {
100 return false;
101 }
102
103 if (recipients == null)
104 return false;
105
106 for (int i=0; i < recipients.length; i++)
107 if (super.match(recipients[i]))
108 return true;
109 return false;
110 }
111
112 /**
113 * Equality comparison.
114 */
115 public boolean equals(Object obj) {
116 if (!(obj instanceof RecipientStringTerm))
117 return false;
118 RecipientStringTerm rst = (RecipientStringTerm)obj;
119 return rst.type.equals(this.type) && super.equals(obj);
120 }
121
122 /**
123 * Compute a hashCode for this object.
124 */
125 public int hashCode() {
126 return type.hashCode() + super.hashCode();
127 }
128 }
Save This Page