Classes

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

Class EventFactory

Class EventFactory	Line # 34	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.eventstream;
21
22		import org.xwiki.component.annotation.Role;
23
24		/**
25		* A factory which creates {@link Event} objects ready to be used. Besides instantiating an Event object, the factory
26		* also fills in some of the fields with the default values, for example a new {@link Event#getId() event ID}, the
27		* current {@link Event#getGroupId() event group id}, the current {@link Event#getUser() user}, and the current
28		* {@link Event#getDate() date}.
29		*
30		* @version $Id: dfbb31dd494d88f1fab6b05f3a21301fd6dc9645 $
31		* @since 3.0M2
32		*/
33		@Role
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
34		public interface EventFactory
35		{
36		/**
37		* Create a new event with some fields already filled in.
38		* <ul>
39		* <li>unique event ID</li>
40		* <li>the current event group ID</li>
41		* <li>the current user</li>
42		* <li>the current date</li>
43		* </ul>
44		*
45		* @return a ready-to-use event
46		*/
47		Event createEvent();
48
49		/**
50		* Create a new event without any of the fields filled in.
51		*
52		* @return a blank event
53		*/
54		Event createRawEvent();
55		}