mail/search/RecipientTerm.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2013 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;

/**
 * This class implements comparisons for the Recipient Address headers.
 *
 * @author Bill Shannon
 * @author John Mani
 */
public final class RecipientTerm extends AddressTerm {

    /**
     * The recipient type.
     *
     * @serial
     */
    private Message.RecipientType type;

    private static final long serialVersionUID = 6548700653122680468L;

    /**
     * Constructor.
     *
     * @param type  the recipient type
     * @param address   the address to match for
     */
    public RecipientTerm(Message.RecipientType type, Address address) {
    super(address);
    this.type = type;
    }

    /**
     * Return the type of recipient to match with.
     *
     * @return  the recipient type
     */
    public Message.RecipientType getRecipientType() {
    return type;
    }

    /**
     * The match method.
     *
     * @param msg   The address match is applied to this Message's recepient
     *          address
     * @return      true if the match succeeds, otherwise false
     */
    public boolean match(Message msg) {
    Address[] recipients;

    try {
        recipients = msg.getRecipients(type);
    } catch (Exception e) {
        return false;
    }

    if (recipients == null)
        return false;

    for (int i=0; i < recipients.length; i++)
        if (super.match(recipients[i]))
        return true;
    return false;
    }

    /**
     * Equality comparison.
     */
    public boolean equals(Object obj) {
    if (!(obj instanceof RecipientTerm))
        return false;
    RecipientTerm rt = (RecipientTerm)obj;
    return rt.type.equals(this.type) && super.equals(obj);
    }

    /**
     * Compute a hashCode for this object.
     */
    public int hashCode() {
    return type.hashCode() + super.hashCode();
    }
}