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 * @(#)SearchTerm.java 1.8 07/05/04
39 */
40
41 package javax.mail.search;
42
43 import java.io.Serializable;
44
45 import javax.mail.Message;
46
47 /**
48 * Search criteria are expressed as a tree of search-terms, forming
49 * a parse-tree for the search expression. <p>
50 *
51 * Search-terms are represented by this class. This is an abstract
52 * class; subclasses implement specific match methods. <p>
53 *
54 * Search terms are serializable, which allows storing a search term
55 * between sessions.
56 *
57 * <strong>Warning:</strong>
58 * Serialized objects of this class may not be compatible with future
59 * JavaMail API releases. The current serialization support is
60 * appropriate for short term storage. <p>
61 *
62 * <strong>Warning:</strong>
63 * Search terms that include references to objects of type
64 * <code>Message.RecipientType</code> will not be deserialized
65 * correctly on JDK 1.1 systems. While these objects will be deserialized
66 * without throwing any exceptions, the resulting objects violate the
67 * <i>type-safe enum</i> contract of the <code>Message.RecipientType</code>
68 * class. Proper deserialization of these objects depends on support
69 * for the <code>readReplace</code> method, added in JDK 1.2.
70 *
71 * @author Bill Shannon
72 * @author John Mani
73 */
74 public abstract class SearchTerm implements Serializable {
75
76 private static final long serialVersionUID = -6652358452205992789L;
77
78 /**
79 * This method applies a specific match criterion to the given
80 * message and returns the result.
81 *
82 * @param msg The match criterion is applied on this message
83 * @return true, it the match succeeds, false if the match fails
84 */
85
86 public abstract boolean match(Message msg);
87 }
Save This Page