View Javadoc

1   /*
2    * $Id: PatternRecognizer.java 795343 2009-07-18 11:26:09Z apetrelli $
3    *
4    * Licensed to the Apache Software Foundation (ASF) under one
5    * or more contributor license agreements.  See the NOTICE file
6    * distributed with this work for additional information
7    * regarding copyright ownership.  The ASF licenses this file
8    * to you under the Apache License, Version 2.0 (the
9    * "License"); you may not use this file except in compliance
10   * with the License.  You may obtain a copy of the License at
11   *
12   * http://www.apache.org/licenses/LICENSE-2.0
13   *
14   * Unless required by applicable law or agreed to in writing,
15   * software distributed under the License is distributed on an
16   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17   * KIND, either express or implied.  See the License for the
18   * specific language governing permissions and limitations
19   * under the License.
20   */
21  
22  package org.apache.tiles.definition.pattern;
23  
24  /**
25   * Checks if a pattern (or a candidate one) is recognized as a pattern.
26   *
27   * @version $Rev: 795343 $ $Date: 2009-07-18 21:26:09 +1000 (Sat, 18 Jul 2009) $
28   * @since 2.2.0
29   */
30  public interface PatternRecognizer {
31  
32      /**
33       * Checks if a pattern is recognized as a pattern.
34       *
35       * @param candidatePattern The pattern to check.
36       * @return <code>true</code> if the pattern has been recognized.
37       * @since 2.2.0
38       */
39      boolean isPatternRecognized(String candidatePattern);
40  }