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 */
019package org.apache.shiro.util;
020
021/**
022 * Interface for components that can match source strings against a specified pattern string.
023 * <p/>
024 * Different implementations can support different pattern types, for example, Ant style path expressions, or
025 * regular expressions, or other types of text based patterns.
026 *
027 * @see org.apache.shiro.util.AntPathMatcher AntPathMatcher
028 * @since 0.9 RC2
029 */
030public interface PatternMatcher {
031
032    /**
033     * Returns <code>true</code> if the given <code>source</code> matches the specified <code>pattern</code>,
034     * <code>false</code> otherwise.
035     *
036     * @param pattern the pattern to match against
037     * @param source  the source to match
038     * @return <code>true</code> if the given <code>source</code> matches the specified <code>pattern</code>,
039     *         <code>false</code> otherwise.
040     */
041    boolean matches(String pattern, String source);
042}