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 * @(#)AddressStringTerm.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 import javax.mail.internet.InternetAddress;
46
47 /**
48 * This abstract class implements string comparisons for Message
49 * addresses. <p>
50 *
51 * Note that this class differs from the <code>AddressTerm</code> class
52 * in that this class does comparisons on address strings rather than
53 * Address objects.
54 *
55 * @since JavaMail 1.1
56 */
57
58 public abstract class AddressStringTerm extends StringTerm {
59
60 private static final long serialVersionUID = 3086821234204980368L;
61
62 /**
63 * Constructor.
64 *
65 * @param pattern the address pattern to be compared.
66 */
67 protected AddressStringTerm(String pattern) {
68 super(pattern, true); // we need case-insensitive comparison.
69 }
70
71 /**
72 * Check whether the address pattern specified in the constructor is
73 * a substring of the string representation of the given Address
74 * object. <p>
75 *
76 * Note that if the string representation of the given Address object
77 * contains charset or transfer encodings, the encodings must be
78 * accounted for, during the match process. <p>
79 *
80 * @param a The comparison is applied to this Address object.
81 * @return true if the match succeeds, otherwise false.
82 */
83 protected boolean match(Address a) {
84 if (a instanceof InternetAddress) {
85 InternetAddress ia = (InternetAddress)a;
86 // We dont use toString() to get "a"'s String representation,
87 // because InternetAddress.toString() returns a RFC 2047
88 // encoded string, which isn't what we need here.
89
90 return super.match(ia.toUnicodeString());
91 } else
92 return super.match(a.toString());
93 }
94
95 /**
96 * Equality comparison.
97 */
98 public boolean equals(Object obj) {
99 if (!(obj instanceof AddressStringTerm))
100 return false;
101 return super.equals(obj);
102 }
103 }
Save This Page