ParameterizedPatternParser.java

/*
 * Copyright 2013 <a href="mailto:lincolnbaxter@gmail.com">Lincoln Baxter, III</a>
 * 
 * Licensed 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.ocpsoft.rewrite.param;

import java.util.regex.Pattern;

/**
 * 
 * A {@link Parameterized} regular expression {@link Pattern}.
 * 
 * @author <a href="mailto:lincolnbaxter@gmail.com">Lincoln Baxter, III</a>
 * 
 */
public interface ParameterizedPatternParser extends ParameterizedPattern
{
    /**
     * Return the {@link ParameterizedPatternBuilder} corresponding to the pattern with which this
     * {@link ParameterizedPatternParser} was constructed.
     */
    ParameterizedPatternBuilder getBuilder();

    /**
     * Return a {@link ParameterizedPatternResult} for the evaluation of this {@link ParameterizedPattern} against the
     * given {@link String}.
     */
    ParameterizedPatternResult parse(String name);
}