Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
WikiReferenceExtractor | 33 | 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.url.internal.standard; | |
21 | ||
22 | import org.xwiki.component.annotation.Role; | |
23 | import org.xwiki.model.reference.WikiReference; | |
24 | import org.xwiki.url.ExtendedURL; | |
25 | ||
26 | /** | |
27 | * Extracts the reference to the wiki pointed to by the specified {@link ExtendedURL} object. | |
28 | * | |
29 | * @version $Id: abaa5d595bd9680e113e2d0485798e68a187f5fe $ | |
30 | * @since 5.1M1 | |
31 | */ | |
32 | @Role | |
33 | public interface WikiReferenceExtractor | |
34 | { | |
35 | /** | |
36 | * Extract the name of the wiki the URL is pointing to. | |
37 | * | |
38 | * @param url the URL from which to extract the wiki reference | |
39 | * @return the reference to the wiki pointed to by the passed URL | |
40 | * @since 6.3M1 returns only a WikiReference (whereas before it was returning both a WikiReference and a boolean) | |
41 | */ | |
42 | WikiReference extract(ExtendedURL url); | |
43 | } |