Class | Line # | Actions | |||||
---|---|---|---|---|---|---|---|
ScriptContextManager | 32 | 1 | 0% | 1 | 2 |
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.script; | |
21 | ||
22 | import javax.script.ScriptContext; | |
23 | ||
24 | import org.xwiki.component.annotation.Role; | |
25 | ||
26 | /** | |
27 | * Helpers for {@link ScriptContext} management. Like context initialization, etc. | |
28 | * | |
29 | * @version $Id: 4cf9427f2b633352884349a407b94b7f951e1ec9 $ | |
30 | */ | |
31 | @Role | |
32 | public interface ScriptContextManager | |
33 | { | |
34 | /** | |
35 | * @return a clean and initialized {@link ScriptContext}. Clean means that all | |
36 | * {@link org.xwiki.script.ScriptContextInitializer} will have been executed on the returned Script Context | |
37 | * which will thus contain re-initialized values for the values which are set in | |
38 | * {@link org.xwiki.script.ScriptContextInitializer}. The values that are set before calling this method and | |
39 | * for which there are no {@link org.xwiki.script.ScriptContextInitializer} will not be modified. | |
40 | */ | |
41 | ScriptContext getScriptContext(); | |
42 | ||
43 | /** | |
44 | * @return the current {@link ScriptContext} instance without any modification. This is mostly used when the only | |
45 | * need to to set values in the script context. In doubt always use {@link #getScriptContext()}. | |
46 | * @see #getScriptContext() | |
47 | * @since 8.3M1 | |
48 | */ | |
49 | 0 | default ScriptContext getCurrentScriptContext() { |
50 | 0 | return getScriptContext(); |
51 | } | |
52 | } |