javax.mail.search.AddressStringTerm Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.mail.search;
import javax.mail.Message;
import javax.mail.Address;
import javax.mail.internet.InternetAddress;
/**
* This abstract class implements string comparisons for Message
* addresses.
*
* Note that this class differs from the AddressTerm class
* in that this class does comparisons on address strings rather than
* Address objects.
*
* @since JavaMail 1.1
*/
public abstract class AddressStringTerm extends StringTerm {
private static final long serialVersionUID = 3086821234204980368L;
/**
* Constructor.
*
* @param pattern the address pattern to be compared.
*/
protected AddressStringTerm(String pattern) {
super(pattern, true); // we need case-insensitive comparison.
}
/**
* Check whether the address pattern specified in the constructor is
* a substring of the string representation of the given Address
* object.
*
* Note that if the string representation of the given Address object
* contains charset or transfer encodings, the encodings must be
* accounted for, during the match process.
*
* @param a The comparison is applied to this Address object.
* @return true if the match succeeds, otherwise false.
*/
protected boolean match(Address a) {
if (a instanceof InternetAddress) {
InternetAddress ia = (InternetAddress)a;
// We dont use toString() to get "a"'s String representation,
// because InternetAddress.toString() returns a RFC 2047
// encoded string, which isn't what we need here.
return super.match(ia.toUnicodeString());
} else
return super.match(a.toString());
}
/**
* Equality comparison.
*/
public boolean equals(Object obj) {
if (!(obj instanceof AddressStringTerm))
return false;
return super.equals(obj);
}
}