Classes

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

Class ComponentEventManager

Class ComponentEventManager	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.component.manager;
21
22		import org.xwiki.component.descriptor.ComponentDescriptor;
23
24		/**
25		* Manages Component Events (when a component instance is created for example). It's recommended that implementations
26		* use the Observation module to send the events. We're introducing this level of indirection in order to be able to
27		* perform some processing before the events are fired. For example one implementation may want to stack the events
28		* before sending them.
29		*
30		* @version $Id: e22170fc69389448095997fe825a961d2dc738e5 $
31		* @since 2.0M1
32		*/
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
33		public interface ComponentEventManager
34		{
35		/**
36		* Notify all listeners that a component with the passed descriptor has been registered.
37		*
38		* @param descriptor the descriptor for the instantiated component
39		* @since 2.0M2
40		* @deprecated since 3.3 use {@link #notifyComponentRegistered(ComponentDescriptor, ComponentManager)} instead
41		*/
42		@Deprecated
43		void notifyComponentRegistered(ComponentDescriptor<?> descriptor);
44
45		/**
46		* Notify all listeners that a component with the passed descriptor has been registered.
47		*
48		* @param descriptor the descriptor for the instantiated component
49		* @param componentManager the ComponentManager where the component has been registered
50		* @since 2.0M2
51		*/
52		void notifyComponentRegistered(ComponentDescriptor<?> descriptor, ComponentManager componentManager);
53
54		/**
55		* Notify all listeners that a component with the passed descriptor has been unregistered.
56		*
57		* @param descriptor the descriptor for the instantiated component
58		* @since 2.0M2
59		* @deprecated since 3.3 use {@link #notifyComponentUnregistered(ComponentDescriptor, ComponentManager)} instead
60		*/
61		@Deprecated
62		void notifyComponentUnregistered(ComponentDescriptor<?> descriptor);
63
64		/**
65		* Notify all listeners that a component with the passed descriptor has been unregistered.
66		*
67		* @param descriptor the descriptor for the instantiated component
68		* @param componentManager the ComponentManager from where the component has been unregistered
69		* @since 3.3
70		*/
71		void notifyComponentUnregistered(ComponentDescriptor<?> descriptor, ComponentManager componentManager);
72		}