001    // Copyright 2004, 2005 The Apache Software Foundation
002    //
003    // Licensed under the Apache License, Version 2.0 (the "License");
004    // you may not use this file except in compliance with the License.
005    // You may obtain a copy of the License at
006    //
007    //     http://www.apache.org/licenses/LICENSE-2.0
008    //
009    // Unless required by applicable law or agreed to in writing, software
010    // distributed under the License is distributed on an "AS IS" BASIS,
011    // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
012    // See the License for the specific language governing permissions and
013    // limitations under the License.
014    
015    package org.apache.tapestry.valid;
016    
017    /**
018     * Implementations of this interface will provide pattern utility services.
019     * 
020     * @author  Harish Krishnaswamy
021     * @since   3.0
022     */
023    public interface PatternDelegate
024    {
025        /**
026         * Answers the question whether the input string fulfills the pattern string provided.
027         * 
028         * @param patternString The pattern that the input string is compared against.
029         * @param input The string under test.
030         * @return Returns true if the pattern exists in the input string; returns false otherwise.
031         */
032        boolean contains(String patternString, String input);
033        
034        /**
035         * Returns the escaped sequence of characters representing the pattern string provided.
036         * 
037         * @param patternString The raw sequence of characters that represent the pattern.
038         * @return The escaped sequence of characters that represent the pattern.
039         */
040        String getEscapedPatternString(String patternString);
041    }