Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
SpaceReferenceResolver | 37 | 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.model.reference; | |
21 | ||
22 | import java.lang.reflect.ParameterizedType; | |
23 | ||
24 | import org.xwiki.component.annotation.Role; | |
25 | import org.xwiki.component.util.DefaultParameterizedType; | |
26 | ||
27 | /** | |
28 | * Resolve a Space reference defined in a given representation into a validated {@link SpaceReference} object, ie with | |
29 | * valid values and a valid hierarchy (eg a Space reference must have a parent which is a space reference or a wiki | |
30 | * reference, reference values must not be null, etc). | |
31 | * | |
32 | * @version $Id: 27afc8a6f0f7d9b17646ca271fb0aca91f5af64a $ | |
33 | * @since 7.2M1 | |
34 | * @param <T> the type of the representation (eg a String) | |
35 | */ | |
36 | @Role | |
37 | public interface SpaceReferenceResolver<T> | |
38 | { | |
39 | /** | |
40 | * Type instance for {@code SpaceReferenceResolver<String>}. | |
41 | */ | |
42 | ParameterizedType TYPE_STRING = new DefaultParameterizedType(null, SpaceReferenceResolver.class, String.class); | |
43 | ||
44 | /** | |
45 | * Type instance for {@code SpaceReferenceResolver<EntityReference>}. | |
46 | */ | |
47 | ParameterizedType TYPE_REFERENCE = new DefaultParameterizedType(null, SpaceReferenceResolver.class, | |
48 | EntityReference.class); | |
49 | ||
50 | /** | |
51 | * @param spaceReferenceRepresentation the representation of a space reference (eg as a String) | |
52 | * @param parameters optional parameters. Their meaning depends on the resolver implementation | |
53 | * @return the valid resolved space reference as an Object | |
54 | */ | |
55 | SpaceReference resolve(T spaceReferenceRepresentation, Object... parameters); | |
56 | } |