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 * @(#)RecipientTerm.java 1.11 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 comparisons for the Recipient Address headers.
48 *
49 * @author Bill Shannon
50 * @author John Mani
51 */
52 public final class RecipientTerm extends AddressTerm {
53
54 /**
55 * The recipient type.
56 *
57 * @serial
58 */
59 protected Message.RecipientType type;
60
61 private static final long serialVersionUID = 6548700653122680468L;
62
63 /**
64 * Constructor.
65 *
66 * @param type the recipient type
67 * @param address the address to match for
68 */
69 public RecipientTerm(Message.RecipientType type, Address address) {
70 super(address);
71 this.type = type;
72 }
73
74 /**
75 * Return the type of recipient to match with.
76 */
77 public Message.RecipientType getRecipientType() {
78 return type;
79 }
80
81 /**
82 * The match method.
83 *
84 * @param msg The address match is applied to this Message's recepient
85 * address
86 * @return true if the match succeeds, otherwise false
87 */
88 public boolean match(Message msg) {
89 Address[] recipients;
90
91 try {
92 recipients = msg.getRecipients(type);
93 } catch (Exception e) {
94 return false;
95 }
96
97 if (recipients == null)
98 return false;
99
100 for (int i=0; i < recipients.length; i++)
101 if (super.match(recipients[i]))
102 return true;
103 return false;
104 }
105
106 /**
107 * Equality comparison.
108 */
109 public boolean equals(Object obj) {
110 if (!(obj instanceof RecipientTerm))
111 return false;
112 RecipientTerm rt = (RecipientTerm)obj;
113 return rt.type.equals(this.type) && super.equals(obj);
114 }
115
116 /**
117 * Compute a hashCode for this object.
118 */
119 public int hashCode() {
120 return type.hashCode() + super.hashCode();
121 }
122 }