View Javadoc

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