Clover Coverage Report - XWiki Rendering - Parent POM 4.0-SNAPSHOT (Aggregated)
Coverage timestamp: Mon Mar 12 2012 18:03:13 CET
0   57   0   -
0   12   -   0
0     -  
1    
 
  MacroContentParser       Line # 34 0 - 0 0 - -1.0
 
No Tests
 
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.macro;
21   
22    import org.xwiki.component.annotation.ComponentRole;
23    import org.xwiki.rendering.block.XDOM;
24    import org.xwiki.rendering.syntax.Syntax;
25    import org.xwiki.rendering.transformation.MacroTransformationContext;
26   
27    /**
28    * Parses content of a macro field (parameter, macro content) in a given syntax.
29    *
30    * @version $Id: 94e9e05fe90b12803b0c4bca4420d3d75e601cc7 $
31    * @since 3.3M1
32    */
33    @ComponentRole
 
34    public interface MacroContentParser
35    {
36    /**
37    * Parses content of a macro field (parameter, macro content) in a given syntax and optionally remove the top level
38    * paragraph.
39    *
40    * @param content the content to parse
41    * @param macroContext the executing Macro context (from which to get the current syntax, etc)
42    * @param transform if true then executes transformations
43    * @param removeTopLevelParagraph whether the top level paragraph should be removed after parsing
44    * @return the result as a {@link org.xwiki.rendering.block.Block}s
45    * @throws MacroExecutionException in case of a parsing error
46    */
47    XDOM parse(String content, MacroTransformationContext macroContext, boolean transform,
48    boolean removeTopLevelParagraph) throws MacroExecutionException;
49   
50    /**
51    * Find the current syntax to use for macro supporting wiki content/parameters/whatever.
52    *
53    * @param context the macro execution context containing the default syntax and the current macro block
54    * @return the current syntax
55    */
56    Syntax getCurrentSyntax(MacroTransformationContext context);
57    }