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 package org.apache.shiro.util;
20
21 /**
22 * Interface for components that can match source strings against a specified pattern string.
23 * <p/>
24 * Different implementations can support different pattern types, for example, Ant style path expressions, or
25 * regular expressions, or other types of text based patterns.
26 *
27 * @see org.apache.shiro.util.AntPathMatcher AntPathMatcher
28 * @since 0.9 RC2
29 */
30 public interface PatternMatcher {
31
32 /**
33 * Returns <code>true</code> if the given <code>source</code> matches the specified <code>pattern</code>,
34 * <code>false</code> otherwise.
35 *
36 * @param pattern the pattern to match against
37 * @param source the source to match
38 * @return <code>true</code> if the given <code>source</code> matches the specified <code>pattern</code>,
39 * <code>false</code> otherwise.
40 */
41 boolean matches(String pattern, String source);
42 }