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 org.apache.jsieve.comparators;
21  
22  import org.apache.jsieve.exception.SieveException;
23  
24  /**
25   * Interface Matches defines the method signatures for matches comparators.
26   */
27  public interface Matches {
28      /**
29       * Method matches answers a <code>boolean</code> indicating if parameter
30       * <code>string1</code> matches the pattern in parameter <code>glob</code>
31       * using the matching rules defind by the implementation.
32       * 
33       * @param string
34       * @param glob
35       * @return boolean
36       */
37      public boolean matches(String string, String glob) throws SieveException;
38  
39  }