Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
WikiMacroBindingInitializer | 36 | 0 | - | 0 | 0 |
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.internal.macro.wikibridge; | |
21 | ||
22 | import java.util.Map; | |
23 | ||
24 | import org.xwiki.component.annotation.Role; | |
25 | import org.xwiki.model.reference.DocumentReference; | |
26 | import org.xwiki.rendering.macro.wikibridge.WikiMacroParameters; | |
27 | import org.xwiki.rendering.transformation.MacroTransformationContext; | |
28 | ||
29 | /** | |
30 | * Initialize the binding provided to the script macros. Called before executing each wiki macro is executed. | |
31 | * | |
32 | * @version $Id: 5222af77b3a4f8f7dafa071c43dbb7506a6ace08 $ | |
33 | * @since 2.5M1 | |
34 | */ | |
35 | @Role | |
36 | public interface WikiMacroBindingInitializer | |
37 | { | |
38 | /** | |
39 | * Initialize the binding provided to the script macros. | |
40 | * | |
41 | * @param macroDocumentReference the reference of the document containing the wiki macro | |
42 | * @param parameters the parameters of the macro | |
43 | * @param macroContent the content of the macro | |
44 | * @param context the macro execution context | |
45 | * @param macroBinding the binding map to fill | |
46 | */ | |
47 | void initialize(DocumentReference macroDocumentReference, WikiMacroParameters parameters, String macroContent, | |
48 | MacroTransformationContext context, Map<String, Object> macroBinding); | |
49 | } |