1 /**
2 * This file Copyright (c) 2003-2014 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 * @author Fabrizio Giustina
42 * @version $Revision$ ($Author$)
43 */
44 public interface UrlPattern extends Serializable {
45
46 /**
47 * Does the patter match the given url?
48 * @param url url to match
49 * @return <code>true</code> if the given URL matches the pattern
50 */
51 boolean match(String url);
52
53 /**
54 * Returns the pattern length. Longer patterns have higher priority.
55 * @return pattern length
56 */
57 int getLength();
58
59 /**
60 * Returns the pattern string.
61 * @return pattern string
62 */
63 String getPatternString();
64
65 /**
66 * A pattern which matches any input.
67 */
68 UrlPattern MATCH_ALL = new MatchAllPattern();
69
70 /**
71 * A default implementation with matches any input.
72 */
73 public static final class MatchAllPattern implements UrlPattern {
74
75 /**
76 * Stable serialVersionUID.
77 */
78 private static final long serialVersionUID = 222L;
79
80 /**
81 * Instantiates a new MatchAllPattern instance. Use the MATCH_ALL constant and don't create new instances.
82 */
83 protected MatchAllPattern() {
84 // protected contructor
85 }
86
87 /**
88 * @see info.magnolia.cms.util.UrlPattern#match(java.lang.String)
89 */
90 @Override
91 public boolean match(String str) {
92 return true;
93 }
94
95 /**
96 * @see info.magnolia.cms.util.UrlPattern#getLength()
97 */
98 @Override
99 public int getLength() {
100 return 1;
101 }
102
103 /**
104 * @see info.magnolia.cms.util.UrlPattern#getString()
105 */
106 @Override
107 public String getPatternString() {
108 return "";
109 }
110 }
111 }