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

Go to download
/*
 * 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.entities.JavetEntityError;
import com.caoccao.javet.entities.JavetEntityFunction;
import com.caoccao.javet.entities.JavetEntityMap;
import com.caoccao.javet.entities.JavetEntitySymbol;
import com.caoccao.javet.enums.V8ValueReferenceType;
import com.caoccao.javet.exceptions.JavetException;
import com.caoccao.javet.interfaces.*;
import com.caoccao.javet.interop.V8Runtime;
import com.caoccao.javet.interop.V8Scope;
import com.caoccao.javet.interop.callback.JavetCallbackContext;
import com.caoccao.javet.interop.proxy.IJavetProxyHandler;
import com.caoccao.javet.utils.JavetResourceUtils;
import com.caoccao.javet.utils.StringUtils;
import com.caoccao.javet.values.V8Value;
import com.caoccao.javet.values.reference.*;

import java.lang.reflect.AccessibleObject;
import java.lang.reflect.Constructor;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.util.*;
import java.util.concurrent.ConcurrentHashMap;
import java.util.stream.BaseStream;

/**
 * The type Javet object converter converts Java primitive types,
 * Array, List, Map and Set to JS primitive types, Array, Map, Set
 * and Object bi-directionally.
 *
 * @since 0.7.2
 */
@SuppressWarnings("unchecked")
public class JavetObjectConverter extends JavetPrimitiveConverter {
    /**
     * The constant EXECUTABLE_INDEX_DEFAULT_CONSTRUCTOR.
     *
     * @since 0.9.12
     */
    protected static final int EXECUTABLE_INDEX_DEFAULT_CONSTRUCTOR = 0;
    /**
     * The constant EXECUTABLE_INDEX_FROM_MAP.
     *
     * @since 0.9.12
     */
    protected static final int EXECUTABLE_INDEX_FROM_MAP = 1;
    /**
     * The constant EXECUTABLE_INDEX_TO_MAP.
     *
     * @since 0.9.12
     */
    protected static final int EXECUTABLE_INDEX_TO_MAP = 2;
    /**
     * The constant METHOD_NAME_FROM_MAP.
     *
     * @since 0.9.12
     */
    protected static final String METHOD_NAME_FROM_MAP = "fromMap";
    /**
     * The constant METHOD_NAME_TO_MAP.
     *
     * @since 0.9.12
     */
    protected static final String METHOD_NAME_TO_MAP = "toMap";
    /**
     * The constant OBJECT_CONVERTER.
     *
     * @since 3.0.4
     */
    protected static final JavetObjectConverter OBJECT_CONVERTER = new JavetObjectConverter();
    /**
     * The constant PRIVATE_PROPERTY_CUSTOM_OBJECT_CLASS_NAME.
     *
     * @since 0.9.6
     */
    protected static final String PRIVATE_PROPERTY_CUSTOM_OBJECT_CLASS_NAME = "JavetObjectConverter#customObjectClassName";
    /**
     * The constant PRIVATE_PROPERTY_PROXY_TARGET.
     *
     * @since 0.9.6
     */
    protected static final String PRIVATE_PROPERTY_PROXY_TARGET = "Javet#proxyTarget";
    /**
     * The constant PROPERTY_NAME.
     *
     * @since 0.7.2
     */
    protected static final String PROPERTY_NAME = "name";
    /**
     * The constant PUBLIC_PROPERTY_CONSTRUCTOR.
     *
     * @since 0.7.2
     */
    protected static final String PUBLIC_PROPERTY_CONSTRUCTOR = "constructor";
    /**
     * The Custom object map.
     *
     * @since 0.9.12
     */
    protected Map customObjectMap;

    /**
     * Instantiates a new Javet object converter.
     *
     * @since 0.7.1
     */
    public JavetObjectConverter() {
        super();
        customObjectMap = new ConcurrentHashMap<>();
    }

    /**
     * Create entity function javet entity function.
     *
     * @return the javet entity function
     * @since 0.9.4
     */
    protected IJavetEntityFunction createEntityFunction() {
        return new JavetEntityFunction();
    }

    /**
     * Create entity map.
     *
     * @return the map
     * @since 0.7.2
     */
    protected Map createEntityMap() {
        return new JavetEntityMap();
    }

    /**
     * Register custom object.
     *
     * @param customObjectClass the custom object class
     * @return true : success, false: failure
     * @since 0.9.12
     */
    @SuppressWarnings("UnusedReturnValue")
    public boolean registerCustomObject(Class customObjectClass) {
        return registerCustomObject(customObjectClass, METHOD_NAME_FROM_MAP, METHOD_NAME_TO_MAP);
    }

    /**
     * Register custom object.
     *
     * @param customObjectClass the custom object class
     * @param methodNameFromMap the method name from map
     * @param methodNameToMap   the method name to map
     * @return true : success, false: failure
     * @since 0.9.12
     */
    public boolean registerCustomObject(Class customObjectClass, String methodNameFromMap, String methodNameToMap) {
        if (customObjectClass == null
                || methodNameFromMap == null || methodNameToMap == null
                || methodNameFromMap.isEmpty() || methodNameToMap.isEmpty()
                || methodNameFromMap.equals(methodNameToMap)) {
            return false;
        }
        String customObjectClassName = customObjectClass.getName();
        if (customObjectMap.containsKey(customObjectClassName)) {
            return false;
        }
        try {
            Constructor defaultConstructor = customObjectClass.getConstructor();
            Method methodFromMap = customObjectClass.getMethod(methodNameFromMap, Map.class);
            if (Modifier.isStatic(methodFromMap.getModifiers())) {
                return false;
            }
            Method methodToMap = customObjectClass.getMethod(methodNameToMap);
            if (Modifier.isStatic(methodToMap.getModifiers())) {
                return false;
            }
            AccessibleObject[] executables = new AccessibleObject[]{defaultConstructor, methodFromMap, methodToMap};
            customObjectMap.put(customObjectClass.getName(), executables);
        } catch (Throwable t) {
            // Do nothing.
            t.printStackTrace(System.err);
        }
        return false;
    }

    @Override
    protected  T toObject(V8Value v8Value, final int depth) throws JavetException {
        T returnObject = super.toObject(v8Value, depth);
        if (!(returnObject instanceof V8Value)) {
            return returnObject;
        }
        if (v8Value instanceof V8ValueArray) {
            V8ValueArray v8ValueArray = (V8ValueArray) v8Value;
            final List