com.caoccao.javet.values.reference.V8ValueGlobalObject Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of javet Show documentation
Javet is Java + V8 (JAVa + V + EighT). It is an awesome way of embedding Node.js and V8 in Java.
There is a newer version: 4.1.1
/*
 * Copyright (c) 2021-2023. caoccao.com Sam Cao
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.caoccao.javet.values.reference;

import com.caoccao.javet.annotations.CheckReturnValue;
import com.caoccao.javet.exceptions.JavetError;
import com.caoccao.javet.exceptions.JavetException;
import com.caoccao.javet.interop.V8Runtime;
import com.caoccao.javet.utils.JavetResourceUtils;
import com.caoccao.javet.utils.SimpleMap;
import com.caoccao.javet.values.V8Value;
import com.caoccao.javet.values.reference.builtin.V8ValueBuiltInJson;
import com.caoccao.javet.values.reference.builtin.V8ValueBuiltInObject;
import com.caoccao.javet.values.reference.builtin.V8ValueBuiltInPromise;
import com.caoccao.javet.values.reference.builtin.V8ValueBuiltInSymbol;

/**
 * The type V8 value global object is a special object.
 * 1. It lives as long as V8 runtime lives.
 * 2. It does not have reference count.
 * 3. It cannot be set to weak.
 * 4. Its clone is itself.
 */
@SuppressWarnings("unchecked")
public final class V8ValueGlobalObject extends V8ValueObject {

    public static final String PROPERTY_JSON = "JSON";
    public static final String PROPERTY_PROMISE = "Promise";
    public static final String PROPERTY_SYMBOL = "Symbol";
    public static final String PROPERTY_OBJECT = "Object";

    /**
     * Instantiates a new V8 value global object.
     *
     * @param handle the handle
     */
    V8ValueGlobalObject(V8Runtime v8Runtime, long handle) throws JavetException {
        super(v8Runtime, handle);
    }

    @Override
    protected void addReference() {
        // Global object lives as long as V8 runtime lives.
    }

    @Override
    public void clearWeak() {
        // Global object is persisted.
    }

    @Override
    public void close(boolean forceClose) throws JavetException {
        // Global object lives as long as V8 runtime lives.
    }

    @CheckReturnValue
    public V8ValueBuiltInJson getBuiltInJson() throws JavetException {
        V8Value v8Value = v8Runtime.getExecutor(PROPERTY_JSON).execute();
        if (v8Value instanceof V8ValueObject) {
            return new V8ValueBuiltInJson(v8Runtime, ((V8ValueObject) v8Value).getHandle());
        }
        JavetResourceUtils.safeClose(v8Value);
        throw new JavetException(JavetError.NotSupported, SimpleMap.of(JavetError.PARAMETER_FEATURE, PROPERTY_JSON));
    }

    @CheckReturnValue
    public V8ValueBuiltInObject getBuiltInObject() throws JavetException {
        V8Value v8Value = v8Runtime.getExecutor(PROPERTY_OBJECT).execute();
        if (v8Value instanceof V8ValueObject) {
            return new V8ValueBuiltInObject(v8Runtime, ((V8ValueObject) v8Value).getHandle());
        }
        JavetResourceUtils.safeClose(v8Value);
        throw new JavetException(JavetError.NotSupported, SimpleMap.of(JavetError.PARAMETER_FEATURE, PROPERTY_OBJECT));
    }

    @CheckReturnValue
    public V8ValueBuiltInPromise getBuiltInPromise() throws JavetException {
        V8Value v8Value = v8Runtime.getExecutor(PROPERTY_PROMISE).execute();
        if (v8Value instanceof V8ValueObject) {
            return new V8ValueBuiltInPromise(v8Runtime, ((V8ValueObject) v8Value).getHandle());
        }
        JavetResourceUtils.safeClose(v8Value);
        throw new JavetException(JavetError.NotSupported, SimpleMap.of(JavetError.PARAMETER_FEATURE, PROPERTY_PROMISE));
    }

    @CheckReturnValue
    public V8ValueBuiltInSymbol getBuiltInSymbol() throws JavetException {
        V8Value v8Value = v8Runtime.getExecutor(PROPERTY_SYMBOL).execute();
        if (v8Value instanceof V8ValueObject) {
            return new V8ValueBuiltInSymbol(v8Runtime, ((V8ValueObject) v8Value).getHandle());
        }
        JavetResourceUtils.safeClose(v8Value);
        throw new JavetException(JavetError.NotSupported, SimpleMap.of(JavetError.PARAMETER_FEATURE, PROPERTY_SYMBOL));
    }

    @Override
    public boolean isWeak() {
        return false;
    }

    @Override
    protected void removeReference() {
        // Global object lives as long as V8 runtime lives.
    }

    @Override
    public void setWeak() {
        // Global object is persisted.
    }

    @Override
    public V8ValueGlobalObject toClone(boolean referenceCopy) {
        return this;
    }
}