View Javadoc

1   /**
2    *
3    * Copyright 2003-2006 The Apache Software Foundation
4    *
5    *  Licensed under the Apache License, Version 2.0 (the "License");
6    *  you may not use this file except in compliance with the License.
7    *  You may obtain a copy of the License at
8    *
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   *
11   *  Unless required by applicable law or agreed to in writing, software
12   *  distributed under the License is distributed on an "AS IS" BASIS,
13   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   *  See the License for the specific language governing permissions and
15   *  limitations under the License.
16   */
17  
18  package javax.mail.search;
19  
20  import java.io.Serializable;
21  import javax.mail.Message;
22  
23  /**
24   * Base class for Terms in a parse tree used to represent a search condition.
25   *
26   * This class is Serializable to allow for the short term persistence of
27   * searches between Sessions; this is not intended for long-term persistence.
28   *
29   * @version $Rev: 421852 $ $Date: 2006-07-14 03:02:19 -0700 (Fri, 14 Jul 2006) $
30   */
31  public abstract class SearchTerm implements Serializable {
32      /**
33       * Checks a matching criteria defined by the concrete subclass of this Term.
34       *
35       * @param message the message to apply the matching criteria to
36       * @return true if the matching criteria is met
37       */
38      public abstract boolean match(Message message);
39  }