org.xwiki.script.safe.ScriptSafeProvider 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

XWiki Commons - Script

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.safe;

import org.xwiki.component.annotation.Role;

/**
 * Provide a wrapped (or not) version of the passed object so that it's safe to use in a public script.
 *
 * @param  the type to make safe for public usage
 * @version $Id: bea6578db3dc76101ae677069a7ee1b9b60cd66a $
 * @since 16.2.0RC1
 */
@Role
public interface ScriptSafeProvider
{
    /**
     * @param  the type of the safe object version
     * @param unsafe the unsafe version of the object
     * @return a safe version of the passed object
     */
     S get(T unsafe);
}