Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
AbstractTypedStringEntityReferenceSerializer | 30 | 2 | 0% | 1 | 3 |
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.internal; | |
21 | ||
22 | import org.xwiki.annotation.reference.TypedStringEntityReferenceSerializer; | |
23 | import org.xwiki.model.reference.EntityReference; | |
24 | import org.xwiki.model.reference.EntityReferenceSerializer; | |
25 | ||
26 | /** | |
27 | * @version $Id: 7282ae1bc2dcb262c6d19acd9242f9036503031a $ | |
28 | * @since 2.3M1 | |
29 | */ | |
30 | public abstract class AbstractTypedStringEntityReferenceSerializer implements TypedStringEntityReferenceSerializer | |
31 | { | |
32 | /** | |
33 | * {@inheritDoc} | |
34 | * <p> | |
35 | * Override to add the protocol in front of the serialization. | |
36 | * </p> | |
37 | * | |
38 | * @see TypedStringEntityReferenceSerializer#serialize(org.xwiki.model.reference.EntityReference) | |
39 | */ | |
40 | 0 | @Override |
41 | public String serialize(EntityReference reference) | |
42 | { | |
43 | // serialize | |
44 | 0 | String serialization = getSerializer().serialize(reference); |
45 | // and add the protocol in front | |
46 | 0 | return reference.getType() + "://" + serialization; |
47 | } | |
48 | ||
49 | /** | |
50 | * @return the serializer used to serialize the reference before adding the type in front. Override to implement a | |
51 | * specific strategy for serialization. | |
52 | */ | |
53 | protected abstract EntityReferenceSerializer<String> getSerializer(); | |
54 | } |