KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > tapestry > valid > PatternDelegate


1 // Copyright 2004, 2005 The Apache Software Foundation
2
//
3
// Licensed under the Apache License, Version 2.0 (the "License");
4
// you may not use this file except in compliance with the License.
5
// You may obtain a copy of the License at
6
//
7
// http://www.apache.org/licenses/LICENSE-2.0
8
//
9
// Unless required by applicable law or agreed to in writing, software
10
// distributed under the License is distributed on an "AS IS" BASIS,
11
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
// See the License for the specific language governing permissions and
13
// limitations under the License.
14

15 package org.apache.tapestry.valid;
16
17 /**
18  * Implementations of this interface will provide pattern utility services.
19  *
20  * @author Harish Krishnaswamy
21  * @since 3.0
22  */

23 public interface PatternDelegate
24 {
25     /**
26      * Answers the question whether the input string fulfills the pattern string provided.
27      *
28      * @param patternString The pattern that the input string is compared against.
29      * @param input The string under test.
30      * @return Returns true if the pattern exists in the input string; returns false otherwise.
31      */

32     public boolean contains(String JavaDoc patternString, String JavaDoc input);
33     
34     /**
35      * Returns the escaped sequence of characters representing the pattern string provided.
36      *
37      * @param patternString The raw sequence of characters that represent the pattern.
38      * @return The escaped sequence of characters that represent the pattern.
39      */

40     public String JavaDoc getEscapedPatternString(String JavaDoc patternString);
41 }
42
Popular Tags