Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
TypedStringEntityReferenceSerializer | 36 | 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.annotation.reference; | |
21 | ||
22 | import org.xwiki.component.annotation.Role; | |
23 | import org.xwiki.model.reference.EntityReference; | |
24 | ||
25 | /** | |
26 | * Typed flavour of the {@code EntityReferenceSerializer<String>}, which adds the type in front of it in the | |
27 | * string serialization (e.g. DOCUMENT://wiki:Space.Page). <br> | |
28 | * Note that, although it performs the roughly the same function as the entity reference serializer this is a different | |
29 | * hierarchy because it's a different strategy and to make it obvious that typed serializers and resolvers should be | |
30 | * used together. | |
31 | * | |
32 | * @version $Id: 6769ffeaf0e7320d079b72cb80c94fa13a36a98e $ | |
33 | * @since 2.3M1 | |
34 | */ | |
35 | @Role | |
36 | public interface TypedStringEntityReferenceSerializer | |
37 | { | |
38 | /** | |
39 | * @param reference the reference to serialize | |
40 | * @return the resulted representation as a string | |
41 | */ | |
42 | String serialize(EntityReference reference); | |
43 | } |