Classes

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

Class WikiComponent

Class WikiComponent	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.component.wiki;
21
22		import java.lang.reflect.Type;
23
24		import org.xwiki.model.reference.DocumentReference;
25
26		/**
27		* Represents the definition of a wiki component implementation. A java component can extend this interface if it needs
28		* to be bound to a document, in order to be unregistered and registered again when the document is modified, and
29		* unregistered when the document is deleted.
30		*
31		* @version $Id: 122fb7648b05aa1fb31b280e8bd1cd73b046f57e $
32		* @since 4.2M3
33		*/
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
34		public interface WikiComponent
35		{
36		/**
37		* Get the reference of the document this component instance is bound to.
38		*
39		* @return the reference to the document holding this wiki component definition.
40		*/
41		DocumentReference getDocumentReference();
42
43		/**
44		* Get the reference to the author of the document this component instance is bound to.
45		*
46		* @return the reference to the author of the document holding this wiki component definition.
47		*/
48		DocumentReference getAuthorReference();
49
50		/**
51		* @return the role implemented by this component implementation.
52		*/
53		Type getRoleType();
54
55		/**
56		* @return the hint of the role implemented by this component implementation.
57		*/
58		String getRoleHint();
59
60		/**
61		* @return the {@link WikiComponentScope} of the component.
62		*/
63		WikiComponentScope getScope();
64		}