Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
ResourceReferenceTypeParser | 34 | 0 | - | 0 | 0 |
1 | /* | |
2 | * See the NOTICE file distributed with this work for additional | |
3 | * information regarding copyright ownership. | |
4 | * | |
5 | * This is free software; you can redistribute it and/or modify it | |
6 | * under the terms of the GNU Lesser General Public License as | |
7 | * published by the Free Software Foundation; either version 2.1 of | |
8 | * the License, or (at your option) any later version. | |
9 | * | |
10 | * This software is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
13 | * Lesser General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU Lesser General Public | |
16 | * License along with this software; if not, write to the Free | |
17 | * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA | |
18 | * 02110-1301 USA, or see the FSF site: http://www.fsf.org. | |
19 | */ | |
20 | package org.xwiki.rendering.parser; | |
21 | ||
22 | import org.xwiki.component.annotation.Role; | |
23 | import org.xwiki.rendering.listener.reference.ResourceReference; | |
24 | import org.xwiki.rendering.listener.reference.ResourceType; | |
25 | ||
26 | /** | |
27 | * Parses a raw Resource Reference by determining if it has the right type and return a non-null | |
28 | * {@link org.xwiki.rendering.listener.reference.ResourceReference} object if it has. | |
29 | * | |
30 | * @version $Id: b913208856430980f745ace664f36cef2988914e $ | |
31 | * @since 2.5RC1 | |
32 | */ | |
33 | @Role | |
34 | public interface ResourceReferenceTypeParser | |
35 | { | |
36 | /** | |
37 | * @return the resource type (document, url, attachment, etc). | |
38 | */ | |
39 | ResourceType getType(); | |
40 | ||
41 | /** | |
42 | * @param reference the raw resource reference to parse | |
43 | * @return the parsed resource information if the passed reference can be parsed by this type parser or null if the | |
44 | * passed reference isn't valid | |
45 | */ | |
46 | ResourceReference parse(String reference); | |
47 | } |