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 * @(#)OrTerm.java 1.12 07/05/04
39 */
40
41 package javax.mail.search;
42
43 import javax.mail.Message;
44
45 /**
46 * This class implements the logical OR operator on individual SearchTerms.
47 *
48 * @author Bill Shannon
49 * @author John Mani
50 */
51 public final class OrTerm extends SearchTerm {
52
53 /**
54 * The array of terms on which the OR operator should
55 * be applied.
56 *
57 * @serial
58 */
59 protected SearchTerm[] terms;
60
61 private static final long serialVersionUID = 5380534067523646936L;
62
63 /**
64 * Constructor that takes two operands.
65 *
66 * @param t1 first term
67 * @param t2 second term
68 */
69 public OrTerm(SearchTerm t1, SearchTerm t2) {
70 terms = new SearchTerm[2];
71 terms[0] = t1;
72 terms[1] = t2;
73 }
74
75 /**
76 * Constructor that takes an array of SearchTerms.
77 *
78 * @param t array of search terms
79 */
80 public OrTerm(SearchTerm[] t) {
81 terms = new SearchTerm[t.length];
82 for (int i = 0; i < t.length; i++)
83 terms[i] = t[i];
84 }
85
86 /**
87 * Return the search terms.
88 */
89 public SearchTerm[] getTerms() {
90 return (SearchTerm[])terms.clone();
91 }
92
93 /**
94 * The OR operation. <p>
95 *
96 * The terms specified in the constructor are applied to
97 * the given object and the OR operator is applied to their results.
98 *
99 * @param msg The specified SearchTerms are applied to this Message
100 * and the OR operator is applied to their results.
101 * @return true if the OR succeds, otherwise false
102 */
103
104 public boolean match(Message msg) {
105 for (int i=0; i < terms.length; i++)
106 if (terms[i].match(msg))
107 return true;
108 return false;
109 }
110
111 /**
112 * Equality comparison.
113 */
114 public boolean equals(Object obj) {
115 if (!(obj instanceof OrTerm))
116 return false;
117 OrTerm ot = (OrTerm)obj;
118 if (ot.terms.length != terms.length)
119 return false;
120 for (int i=0; i < terms.length; i++)
121 if (!terms[i].equals(ot.terms[i]))
122 return false;
123 return true;
124 }
125
126 /**
127 * Compute a hashCode for this object.
128 */
129 public int hashCode() {
130 int hash = 0;
131 for (int i=0; i < terms.length; i++)
132 hash += terms[i].hashCode();
133 return hash;
134 }
135 }