Classes

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

Class UserDataExtractor

Class UserDataExtractor	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 com.xpn.xwiki.internal.plugin.rightsmanager;
21
22		import org.xwiki.model.reference.DocumentReference;
23
24		import com.xpn.xwiki.doc.XWikiDocument;
25		import com.xpn.xwiki.objects.BaseObject;
26
27		/**
28		* Extracts user profile data.
29		*
30		* @param <T> the type of data extracted from the user profile
31		* @version $Id: 6e1c1f56ec5f8b4bbbe7e113bfa1d833d0c69ef0 $
32		* @since 6.4.2
33		* @since 7.0M2
34		*/
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
35		public interface UserDataExtractor<T>
36		{
37		/**
38		* Since the superadmin user is a virtual user, allow handling what to return when extracting data for it.
39		*
40		* @param reference the reference to the superadmin user
41		* @return the extracted data and if null then the iterator will not return it and look for the next non-null value
42		*/
43		T extractFromSuperadmin(DocumentReference reference);
44
45		/**
46		* Since the guest user is a virtual user, allow handling what to return when extracting data for it.
47		*
48		* @param reference the reference to the guest user
49		* @return the extracted data and if null then the iterator will not return it and look for the next non-null value
50		*/
51		T extractFromGuest(DocumentReference reference);
52
53		/**
54		* @param reference the reference to the user
55		* @param document the user document, corresponding to the passed reference
56		* @param userObject the XObject representing the user
57		* @return the extracted data and if null then the iterator will not return it and look for the next non-null value
58		*/
59		T extract(DocumentReference reference, XWikiDocument document, BaseObject userObject);
60		}