001    /**
002     *
003     * Copyright 2003-2006 The Apache Software Foundation
004     *
005     *  Licensed under the Apache License, Version 2.0 (the "License");
006     *  you may not use this file except in compliance with the License.
007     *  You may obtain a copy of the License at
008     *
009     *     http://www.apache.org/licenses/LICENSE-2.0
010     *
011     *  Unless required by applicable law or agreed to in writing, software
012     *  distributed under the License is distributed on an "AS IS" BASIS,
013     *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014     *  See the License for the specific language governing permissions and
015     *  limitations under the License.
016     */
017    
018    package javax.mail.search;
019    
020    import java.io.Serializable;
021    import javax.mail.Message;
022    
023    /**
024     * Base class for Terms in a parse tree used to represent a search condition.
025     *
026     * This class is Serializable to allow for the short term persistence of
027     * searches between Sessions; this is not intended for long-term persistence.
028     *
029     * @version $Rev: 421852 $ $Date: 2006-07-14 03:02:19 -0700 (Fri, 14 Jul 2006) $
030     */
031    public abstract class SearchTerm implements Serializable {
032        /**
033         * Checks a matching criteria defined by the concrete subclass of this Term.
034         *
035         * @param message the message to apply the matching criteria to
036         * @return true if the matching criteria is met
037         */
038        public abstract boolean match(Message message);
039    }