Classes

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

Class Parser

Class Parser	Line # 35	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.rendering.parser;
21
22		import java.io.Reader;
23
24		import org.xwiki.component.annotation.Role;
25		import org.xwiki.rendering.block.XDOM;
26		import org.xwiki.rendering.syntax.Syntax;
27
28		/**
29		* Parse content into a XDOM (a tree of {@link org.xwiki.rendering.block.Block}s).
30		*
31		* @version $Id: 8b8ffd30b76240d93037232013281832fc0674a8 $
32		* @since 1.5M2
33		*/
34		@Role
		- Uncovered Elements: 0 (0) Complexity: 0 Complexity Density: -
35		public interface Parser
36		{
37		/**
38		* @return the syntax the parser is implementing
39		*/
40		Syntax getSyntax();
41
42		/**
43		* @param source the content to parse
44		* @return the tree representation of the content as {@link org.xwiki.rendering.block.Block}s
45		* @throws ParseException if the source cannot be read or an unexpected error happens during the parsing. Parsers
46		* should be written to not generate any error as much as possible.
47		*/
48		XDOM parse(Reader source) throws ParseException;
49		}