javax.mail.search.SearchTerm Maven / Gradle / Ivy
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the "License"). You may not use this file except
* in compliance with the License.
*
* You can obtain a copy of the license at
* glassfish/bootstrap/legal/CDDLv1.0.txt or
* https://glassfish.dev.java.net/public/CDDLv1.0.html.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* HEADER in each file and include the License file at
* glassfish/bootstrap/legal/CDDLv1.0.txt. If applicable,
* add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your
* own identifying information: Portions Copyright [yyyy]
* [name of copyright owner]
*/
/*
* @(#)SearchTerm.java 1.7 05/08/29
*
* Copyright 1997-2005 Sun Microsystems, Inc. All Rights Reserved.
*/
package javax.mail.search;
import java.io.Serializable;
import javax.mail.Message;
/**
* Search criteria are expressed as a tree of search-terms, forming
* a parse-tree for the search expression.
*
* Search-terms are represented by this class. This is an abstract
* class; subclasses implement specific match methods.
*
* Search terms are serializable, which allows storing a search term
* between sessions.
*
* Warning:
* Serialized objects of this class may not be compatible with future
* JavaMail API releases. The current serialization support is
* appropriate for short term storage.
*
* Warning:
* Search terms that include references to objects of type
* Message.RecipientType will not be deserialized
* correctly on JDK 1.1 systems. While these objects will be deserialized
* without throwing any exceptions, the resulting objects violate the
* type-safe enum contract of the Message.RecipientType
* class. Proper deserialization of these objects depends on support
* for the readReplace method, added in JDK 1.2.
*
* @author Bill Shannon
* @author John Mani
*/
public abstract class SearchTerm implements Serializable {
private static final long serialVersionUID = -6652358452205992789L;
/**
* This method applies a specific match criterion to the given
* message and returns the result.
*
* @param msg The match criterion is applied on this message
* @return true, it the match succeeds, false if the match fails
*/
public abstract boolean match(Message msg);
}