1. Project Clover database Sat Feb 2 2019 06:45:20 CET
  2. Package org.xwiki.component.wiki.internal.bridge

File ContentParser.java

 

Code metrics

0
0
0
1
58
12
0
-
-
0
-

Classes

Class Line # Actions
ContentParser 35 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

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.internal.bridge;
21   
22    import org.xwiki.component.annotation.Role;
23    import org.xwiki.component.wiki.WikiComponentException;
24    import org.xwiki.model.reference.EntityReference;
25    import org.xwiki.rendering.block.XDOM;
26    import org.xwiki.rendering.syntax.Syntax;
27   
28    /**
29    * A bridge between Wiki Components and the rendering module.
30    *
31    * @version $Id: ee9162ad0d53735374992dda44a9fa15eb3404a0 $
32    * @since 4.3M2
33    */
34    @Role
 
35    public interface ContentParser
36    {
37    /**
38    * Parse content.
39    *
40    * @param content the content to parse
41    * @param syntax the syntax in which the content is written
42    * @return the XDOM corresponding to the parsed content
43    * @throws WikiComponentException if the content can't be parsed
44    */
45    XDOM parse(String content, Syntax syntax) throws WikiComponentException;
46   
47    /**
48    * Parse content.
49    *
50    * @param content the content to parse
51    * @param syntax the syntax in which the content is written
52    * @param source the source entity (mostly a Document Reference) containing the parsed content.
53    * @return the XDOM corresponding to the parsed content
54    * @throws WikiComponentException if the content can't be parsed
55    * @since 6.0M2
56    */
57    XDOM parse(String content, Syntax syntax, EntityReference source) throws WikiComponentException;
58    }