com.caoccao.javet.interop.converters.IJavetConverter Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of javet-macos Show documentation

Javet is Java + V8 (JAVa + V + EighT). It is an awesome way of embedding Node.js and V8 in Java.

The newest version!

/*
 * Copyright (c) 2021-2024. 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.interop.converters;

import com.caoccao.javet.annotations.CheckReturnValue;
import com.caoccao.javet.exceptions.JavetException;
import com.caoccao.javet.interop.V8Runtime;
import com.caoccao.javet.utils.JavetResourceUtils;
import com.caoccao.javet.values.V8Value;

/**
 * The interface Javet converter.
 *
 * @since 0.7.1
 */
public interface IJavetConverter {
    /**
     * Gets config.
     *
     * @return the config
     * @since 0.9.4
     */
    JavetConverterConfig getConfig();

    /**
     * To object from V8 value.
     * 
     * Don't override this function, instead, override the one with depth as argument
     * for circular structure detection.
     *
     * @param      the type parameter
     * @param v8Value the V8 value
     * @return the object
     * @throws JavetException the javet exception
     * @since 0.7.1
     */
     T toObject(V8Value v8Value) throws JavetException;

    /**
     * To object from V8 value and auto close the V8 value.
     *
     * @param        the type parameter
     * @param v8Value   the V8 value
     * @param autoClose the auto close
     * @return the object
     * @throws JavetException the javet exception
     * @since 0.8.5
     */
    default  T toObject(V8Value v8Value, boolean autoClose) throws JavetException {
        if (autoClose) {
            try {
                return toObject(v8Value);
            } finally {
                JavetResourceUtils.safeClose(v8Value);
            }
        } else {
            return toObject(v8Value);
        }
    }

    /**
     * To V8 value from object.
     * 
     * Don't override this function, instead, override the one with depth as argument
     * for circular structure detection.
     *
     * @param        the type parameter
     * @param v8Runtime the V8 runtime
     * @param object    the object
     * @return the V8 value
     * @throws JavetException the javet exception
     * @since 0.7.2
     */
    @CheckReturnValue
     T toV8Value(V8Runtime v8Runtime, Object object) throws JavetException;
}