com.caoccao.javet.values.reference.V8ValueSymbol 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.values.reference;

import com.caoccao.javet.annotations.CheckReturnValue;
import com.caoccao.javet.enums.V8ValueReferenceType;
import com.caoccao.javet.exceptions.JavetException;
import com.caoccao.javet.interop.V8Runtime;
import com.caoccao.javet.values.IV8ValuePrimitiveValue;

/**
 * The type V8 value symbol.
 *
 * @since 0.9.11
 */
public class V8ValueSymbol
        extends V8ValueObject
        implements IV8ValuePrimitiveValue {
    /**
     * The constant FUNCTION_TO_STRING.
     *
     * @since 0.9.11
     */
    protected static final String FUNCTION_TO_STRING = "toString";
    /**
     * The Description.
     *
     * @since 3.0.4
     */
    protected String description;

    /**
     * Instantiates a new V8 value symbol.
     *
     * @param v8Runtime the v 8 runtime
     * @param handle    the handle
     * @throws JavetException the javet exception
     * @since 0.9.11
     */
    V8ValueSymbol(V8Runtime v8Runtime, long handle) throws JavetException {
        super(v8Runtime, handle);
        description = null;
    }

    /**
     * Gets description.
     *
     * @return the description
     * @throws JavetException the javet exception
     * @since 0.9.11
     */
    public String getDescription() throws JavetException {
        if (description == null) {
            description = checkV8Runtime().getV8Internal().symbolDescription(this);
        }
        return description;
    }

    @Override
    public V8ValueReferenceType getType() {
        return V8ValueReferenceType.Symbol;
    }

    /**
     * Convert to V8 value symbol object.
     *
     * @return the V8 value symbol object
     * @throws JavetException the javet exception
     * @since 3.0.4
     */
    @CheckReturnValue
    @Override
    public V8ValueSymbolObject toObject() throws JavetException {
        return checkV8Runtime().getV8Internal().symbolToObject(this);
    }

    @Override
    public String toString() {
        try {
            return invokeString(FUNCTION_TO_STRING);
        } catch (JavetException e) {
            return e.getMessage();
        }
    }
}