Classes

Class	Line #	Total Statements	% Filtered	Complexity	Uncovered Elements	TOTAL Coverage	Actions
PluginApi	35	7	0%	5	11	0.1538461615.4%	Show methods

Class PluginApi

Class PluginApi	Line # 35	Total Statements 7	% Filtered 0%	Complexity 5	Uncovered Elements 11	TOTAL Coverage 0.1538461615.4%
PluginApi(T,XWikiContext)   PluginApi(T,XWikiContext)	4848	2.02	0.00%	1.01	2.02	0.0 0.00%
getProtectedPlugin() : T   getProtectedPlugin() : T	6262	1.01	0.00%	1.01	0.00	1.0 1.0100%
getInternalPlugin() : T   getInternalPlugin() : T	7373	3.03	0.00%	2.02	5.05	0.0 0.00%
setPlugin(T) : void   setPlugin(T) : void	8787	1.01	0.00%	1.01	1.01	0.0 0.00%

 

Contributing tests

Contributing tests

Select all

	Test contribution	Test	Result	Actions
	0.3846154	org.xwiki.activitystream.WebRssTest.webRssDisplayorg.xwiki.activitystream.WebRssTest.webRssDisplay	3FAIL
	0.15384616	com.xpn.xwiki.plugin.mailsender.MailSenderApiTest.testSendMailWithCustomConfigurationcom.xpn.xwiki.plugin.mailsender.MailSenderApiTest.testSendMailWithCustomConfiguration	1PASS
	0.15384616	com.xpn.xwiki.plugin.mailsender.MailSenderApiTest.testSendRawMessagecom.xpn.xwiki.plugin.mailsender.MailSenderApiTest.testSendRawMessage	1PASS
	0.15384616	com.xpn.xwiki.plugin.mailsender.MailSenderApiTest.testSendMailcom.xpn.xwiki.plugin.mailsender.MailSenderApiTest.testSendMail	1PASS

 

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.plugin;
21
22		import com.xpn.xwiki.XWikiContext;
23		import com.xpn.xwiki.api.Api;
24
25		/**
26		* Base class for all plugin APIs. API Objects are the Java Objects that can be manipulated from Velocity or Groovy
27		* scripts in XWiki documents. They wrap around a fully functional and privileged Plugin object, and forward safe calls
28		* to that object.
29		*
30		* @param <T> The type of the internal plugin.
31		* @version $Id: c559897b350c526e2b37836af79d90fa6071c9e5 $
32		* @deprecated the plugin technology is deprecated, consider rewriting as components
33		*/
34		@Deprecated
		15.4% Uncovered Elements: 11 (13) Complexity: 5 Complexity Density: 0.71
35		public class PluginApi<T extends XWikiPluginInterface> extends Api
36		{
37		/**
38		* The inner plugin object. API calls are usually forwarded to this object.
39		*/
40		private T plugin;
41
42		/**
43		* API constructor. The API must know the plugin object it wraps, and the request context.
44		*
45		* @param plugin The wrapped plugin object.
46		* @param context Context of the request.
47		*/
		0% Uncovered Elements: 2 (2) Complexity: 1 Complexity Density: 0.5
48	0	public PluginApi(T plugin, XWikiContext context)...
49		{
50	0	super(context);
51	0	setPlugin(plugin);
52		}
53
54		/**
55		* Return the inner plugin object. This method is only for the plugin API's internal use, and should not be exposed
56		* to scripting languages. It is an XWiki practice to expose all the functionality using an API, and allow access to
57		* the internal objects only to users with Programming Rights.
58		*
59		* @return The wrapped plugin object.
60		* @since 1.3RC1
61		*/
		100% Uncovered Elements: 0 (1) Complexity: 1 Complexity Density: 1
62	21731	protected T getProtectedPlugin()...
63		{
64	21731	return this.plugin;
65		}
66
67		/**
68		* Return the inner plugin object, if the user has the required programming rights.
69		*
70		* @return The wrapped plugin object.
71		* @since 1.3RC1
72		*/
		0% Uncovered Elements: 5 (5) Complexity: 2 Complexity Density: 0.67
73	0	public T getInternalPlugin()...
74		{
75	0	if (hasProgrammingRights()) {
76	0	return this.plugin;
77		}
78	0	return null;
79		}
80
81		/**
82		* Set the inner plugin object.
83		*
84		* @param plugin The wrapped plugin object.
85		*/
86		// TODO: Is this really needed? The inner plugin should not be changed.
		0% Uncovered Elements: 1 (1) Complexity: 1 Complexity Density: 1
87	0	public void setPlugin(T plugin)...
88		{
89	0	this.plugin = plugin;
90		}
91		}