Classes

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

Class Editor

Class Editor	Line # 36	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.edit;
21
22		import java.util.Map;
23
24		import org.xwiki.component.annotation.Role;
25		import org.xwiki.stability.Unstable;
26
27		/**
28		* Base interface for editors.
29		*
30		* @param <D> the type of data that can be edited by this editor
31		* @version $Id: 67cc4215247e0ec54c4a2eb1268280f81e122161 $
32		* @since 8.2RC1
33		*/
34		@Role
35		@Unstable
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
36		public interface Editor<D>
37		{
38		/**
39		* @return this editor's descriptor
40		*/
41		EditorDescriptor getDescriptor();
42
43		/**
44		* Generates the HTML code needed to edit the given data.
45		*
46		* @param data the data to edit
47		* @param parameters editor parameters
48		* @return the HTML code that displays the editor
49		* @throws EditException if the editor fails to be rendered
50		*/
51		String render(D data, Map<String, Object> parameters) throws EditException;
52		}