001package org.apache.commons.digester3;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 *   http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022/**
023 * Regular expression matching strategy for RegexRules.
024 * 
025 * @since 1.5
026 */
027public abstract class RegexMatcher
028{
029
030    /**
031     * Returns true if the given pattern matches the given path according to the regex algorithm that this strategy
032     * applies.
033     * 
034     * @param pathPattern the standard digester path representing the element
035     * @param rulePattern the regex pattern the path will be tested against
036     * @return true if the given pattern matches the given path
037     */
038    public abstract boolean match( String pathPattern, String rulePattern );
039
040}