trunk/main/src/main/java/org/apache/jsieve/comparators/Matches.java

/****************************************************************
 * Licensed to the Apache Software Foundation (ASF) under one   *
 * or more contributor license agreements.  See the NOTICE file *
 * distributed with this work for additional information        *
 * regarding copyright ownership.  The ASF licenses this file   *
 * to you under the Apache License, Version 2.0 (the            *
 * "License"); you may not use this file except in compliance   *
 * with the License.  You may obtain a copy of the License at   *
 *                                                              *
 *   http://www.apache.org/licenses/LICENSE-2.0                 *
 *                                                              *
 * Unless required by applicable law or agreed to in writing,   *
 * software distributed under the License is distributed on an  *
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY       *
 * KIND, either express or implied.  See the License for the    *
 * specific language governing permissions and limitations      *
 * under the License.                                           *
 ****************************************************************/

package org.apache.jsieve.comparators;

import org.apache.jsieve.exception.SieveException;

/**
 * Interface Matches defines the method signatures for matches comparators.
 */
public interface Matches {
    /**
     * Method matches answers a <code>boolean</code> indicating if parameter
     * <code>string1</code> matches the pattern in parameter <code>glob</code>
     * using the matching rules defind by the implementation.
     * 
     * @param string
     * @param glob
     * @return boolean
     */
    public boolean matches(String string, String glob) throws SieveException;

}