View Javadoc
1   /**
2    * This file Copyright (c) 2003-2018 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.cms.util;
35  
36  import java.io.Serializable;
37  
38  
39  /**
40   * Pattern interface, used to match URLs.
41   */
42  public interface UrlPattern extends Serializable {
43  
44      /**
45       * Does the patter match the given url?
46       *
47       * @param url url to match
48       * @return <code>true</code> if the given URL matches the pattern
49       */
50      boolean match(String url);
51  
52      /**
53       * Returns the pattern length. Longer patterns have higher priority.
54       *
55       * @return pattern length
56       */
57      int getLength();
58  
59      /**
60       * Returns the pattern string.
61       *
62       * @return pattern string
63       */
64      String getPatternString();
65  
66      /**
67       * A pattern which matches any input.
68       */
69      UrlPattern MATCH_ALL = new MatchAllPattern();
70  
71      /**
72       * A default implementation with matches any input.
73       */
74      public static final class MatchAllPattern implements UrlPattern {
75  
76          /**
77           * Instantiates a new MatchAllPattern instance. Use the MATCH_ALL constant and don't create new instances.
78           */
79          protected MatchAllPattern() {
80              // protected constructor
81          }
82  
83          @Override
84          public boolean match(String str) {
85              return true;
86          }
87  
88          @Override
89          public int getLength() {
90              return 1;
91          }
92  
93          @Override
94          public String getPatternString() {
95              return "";
96          }
97      }
98  }