com.labymedia.ultralight.javascript.interop.JavascriptObjectHasInstanceTester Maven / Gradle / Ivy

Go to download
/*
 * Ultralight Java - Java wrapper for the Ultralight web engine
 * Copyright (C) 2020 - 2021 LabyMedia and contributors
 *
 * This program 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 3 of the License, or (at your option) any later version.
 *
 * This program 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 program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

package com.labymedia.ultralight.javascript.interop;

import com.labymedia.ultralight.annotation.NativeCall;
import com.labymedia.ultralight.annotation.NativeType;
import com.labymedia.ultralight.javascript.JavascriptContext;
import com.labymedia.ultralight.javascript.JavascriptObject;
import com.labymedia.ultralight.javascript.JavascriptValue;

/**
 * Callback when an object is used with an instanceof test.
 */
@NativeType("JSObjectHasInstanceCallback")
public interface JavascriptObjectHasInstanceTester {
    /**
     * The callback invoked when an object is used as the target of an 'instanceof' expression.
     *
     * @param context          The execution context to use
     * @param constructor      The object that is the target of the 'instanceof' expression
     * @param possibleInstance The value being tested to determine if it is an instance of constructor
     * @return {@code true} if possibleInstance is an instance of constructor, otherwise {@code false}
     * @throws JavascriptInteropException If an error occurs while testing if the object is an instance of the value
     */
    @NativeCall
    boolean hasJavascriptInstance(
            JavascriptContext context, JavascriptObject constructor, JavascriptValue possibleInstance)
            throws JavascriptInteropException;
}