001    /*
002     * Licensed to the Apache Software Foundation (ASF) under one
003     * or more contributor license agreements.  See the NOTICE file
004     * distributed with this work for additional information
005     * regarding copyright ownership.  The ASF licenses this file
006     * to you under the Apache License, Version 2.0 (the
007     * "License"); you may not use this file except in compliance
008     * with the License.  You may obtain a copy of the License at
009     *
010     *  http://www.apache.org/licenses/LICENSE-2.0
011     *
012     * Unless required by applicable law or agreed to in writing,
013     * software distributed under the License is distributed on an
014     * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015     * KIND, either express or implied.  See the License for the
016     * specific language governing permissions and limitations
017     * under the License.
018     */
019    
020    package javax.mail.search;
021    
022    import java.io.Serializable;
023    import javax.mail.Message;
024    
025    /**
026     * Base class for Terms in a parse tree used to represent a search condition.
027     *
028     * This class is Serializable to allow for the short term persistence of
029     * searches between Sessions; this is not intended for long-term persistence.
030     *
031     * @version $Rev: 920714 $ $Date: 2010-03-09 01:55:49 -0500 (Tue, 09 Mar 2010) $
032     */
033    public abstract class SearchTerm implements Serializable {
034            
035            private static final long serialVersionUID = -6652358452205992789L;
036            
037        /**
038         * Checks a matching criteria defined by the concrete subclass of this Term.
039         *
040         * @param message the message to apply the matching criteria to
041         * @return true if the matching criteria is met
042         */
043        public abstract boolean match(Message message);
044    }