Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
VelocityMacroFilter | 32 | 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.macro.velocity.filter; | |
21 | ||
22 | import org.apache.velocity.VelocityContext; | |
23 | import org.xwiki.component.annotation.Role; | |
24 | ||
25 | /** | |
26 | * Component called before and after velocity execution in velocity macro to modify the content to execute or parse. It | |
27 | * can be used for example to reformat the velocity content to take care of indentation etc. | |
28 | * | |
29 | * @version $Id: b97b50e56118be8ff2152dc169177588e15d5d89 $ | |
30 | */ | |
31 | @Role | |
32 | public interface VelocityMacroFilter | |
33 | { | |
34 | /** | |
35 | * Called just before the velocity script is executed. | |
36 | * | |
37 | * @param content the velocity script | |
38 | * @param velocityContext the velocity context. this method can inject here bindings usable in the script like | |
39 | * <code>$somebinding</code>. | |
40 | * @return the modified content | |
41 | */ | |
42 | String before(String content, VelocityContext velocityContext); | |
43 | ||
44 | /** | |
45 | * Called just before the result of the velocity script execution is parsed. | |
46 | * | |
47 | * @param content the result of the velocity script execution | |
48 | * @param velocityContext the velocity context. This method usually clean the bindings injected in the velocity | |
49 | * context by {@link #before(String, VelocityContext)} | |
50 | * @return the modified content | |
51 | */ | |
52 | String after(String content, VelocityContext velocityContext); | |
53 | } |