Classes

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

Class ResourceReferenceSerializer

Class ResourceReferenceSerializer	Line # 33	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.resource;
21
22		import org.xwiki.component.annotation.Role;
23
24		/**
25		* Transforms a Resource Reference into some other representation (eg URL).
26		*
27		* @version $Id: abb47926c20b75a914c2419f81131cdfc4eb9e28 $
28		* @since 6.1M2
29		* @param <T> the type of the resource reference to serialize
30		* @param <U> the return type (e.g. a URL, a String, etc)
31		*/
32		@Role
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
33		public interface ResourceReferenceSerializer<T extends ResourceReference, U>
34		{
35		/**
36		* Transforms a Resource Reference into some other representation.
37		*
38		* @param resource the Resource Reference to transform
39		* @return the new representation
40		* @throws SerializeResourceReferenceException if there was an error while serializing the XWiki Resource object
41		* @throws UnsupportedResourceReferenceException if the passed representation points to an unsupported Resource
42		* Reference type that we don't know how to serialize
43		*/
44		U serialize(T resource) throws SerializeResourceReferenceException, UnsupportedResourceReferenceException;
45		}