org.xwiki.script.ScriptContextManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xwiki-commons-script Show documentation

Scripting APIs, on top of JSR-223

There is a newer version: 16.10.0-rc-1

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.script;

import javax.script.ScriptContext;

import org.xwiki.component.annotation.Role;

/**
 * Helpers for {@link ScriptContext} management. Like context initialization, etc.
 *
 * @version $Id: f3faf54fac416f2e02f6a20d5fe14817ffb62b8c $
 */
@Role
public interface ScriptContextManager
{
    /**
     * @return a clean and initialized {@link ScriptContext}. Clean means that all
     *         {@link org.xwiki.script.ScriptContextInitializer} will have been executed on the returned Script Context
     *         which will thus contain re-initialized values for the values which are set in
     *         {@link org.xwiki.script.ScriptContextInitializer}. The values that are set before calling this method and
     *         for which there are no {@link org.xwiki.script.ScriptContextInitializer} will not be modified.
     */
    ScriptContext getScriptContext();

    /**
     * @return the current {@link ScriptContext} instance without any modification. This is mostly used when the only
     *         need is to modify the script context. In doubt always use {@link #getScriptContext()}.
     * @see #getScriptContext()
     * @since 8.3M1
     */
    default ScriptContext getCurrentScriptContext()
    {
        return getScriptContext();
    }
}