Classes

Class	Line #	Total Statements	% Filtered	Complexity	Uncovered Elements	TOTAL Coverage	Actions
EntityReferenceSerializer	35	0	-	0	0	-1.0 -	Show methods

Class EntityReferenceSerializer

Class EntityReferenceSerializer	Line # 35	Total Statements 0	% Filtered -	Complexity 0	Uncovered Elements 0	TOTAL Coverage -1.0 -

 

Contributing tests

Source view

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		* Generate a different representation of an Entity Reference (eg as a String).
29		*
30		* @param <T> the type of the new representation
31		* @version $Id: cddba2459ddd16b8e2ebe6d951b716720f2f33bf $
32		* @since 2.2M1
33		*/
34		@Role
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
35		public interface EntityReferenceSerializer<T>
36		{
37		/**
38		* Type instance for {@code EntityReferenceResolver<String>}.
39		*
40		* @since 4.0M1
41		*/
42		ParameterizedType TYPE_STRING = new DefaultParameterizedType(null, EntityReferenceSerializer.class, String.class);
43
44		/**
45		* Type instance for {@code EntityReferenceResolver<EntityReference>}.
46		*
47		* @since 4.0M1
48		*/
49		ParameterizedType TYPE_REFERENCE = new DefaultParameterizedType(null, EntityReferenceSerializer.class,
50		EntityReference.class);
51
52		/**
53		* Serialize an entity reference into a new representation of type <code>T</code>.
54		*
55		* @param reference the reference to serialize
56		* @param parameters optional parameters. Their meaning depends on the serializer implementation
57		* @return the new representation (eg as a String)
58		*/
59		T serialize(EntityReference reference, Object... parameters);
60		}