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

/*
 * 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.exceptions.JavetException;

/**
 * The interface for V8 value set.
 *
 * @since 0.7.0
 */
public interface IV8ValueSet extends IV8ValueKeyContainer {
    /**
     * Add.
     *
     * @param key the key
     * @throws JavetException the javet exception
     * @since 0.7.0
     */
    void add(Object key) throws JavetException;

    /**
     * Add null.
     *
     * @throws JavetException the javet exception
     * @since 0.7.0
     */
    default void addNull() throws JavetException {
        add(getV8Runtime().createV8ValueNull());
    }

    /**
     * Add undefined.
     *
     * @throws JavetException the javet exception
     * @since 0.7.0
     */
    default void addUndefined() throws JavetException {
        add(getV8Runtime().createV8ValueUndefined());
    }

    /**
     * As array.
     *
     * @return the V8 value array
     * @throws JavetException the javet exception
     * @since 3.0.4
     */
    @CheckReturnValue
    IV8ValueArray asArray() throws JavetException;

    /**
     * Clear.
     *
     * @throws JavetException the javet exception
     * @since 3.0.4
     */
    void clear() throws JavetException;

    /**
     * Gets entries.
     *
     * @return the entries
     * @throws JavetException the javet exception
     * @since 0.7.2
     */
    @CheckReturnValue
    IV8ValueIterator getEntries() throws JavetException;
}