org.pkl.thirdparty.graalvm.polyglot.EnvironmentAccess Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pkl-tools Show documentation

Fat Jar containing pkl-cli, pkl-codegen-java, pkl-codegen-kotlin, pkl-config-java, pkl-core, pkl-doc, and their shaded third-party dependencies.

There is a newer version: 0.27.1

Show newest version

/*
 * Copyright (c) 2019, 2022, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * The Universal Permissive License (UPL), Version 1.0
 *
 * Subject to the condition set forth below, permission is hereby granted to any
 * person obtaining a copy of this software, associated documentation and/or
 * data (collectively the "Software"), free of charge and under any and all
 * copyright rights in the Software, and any and all patent rights owned or
 * freely licensable by each licensor hereunder covering either (i) the
 * unmodified Software as contributed to or provided by such licensor, or (ii)
 * the Larger Works (as defined below), to deal in both
 *
 * (a) the Software, and
 *
 * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
 * one is included with the Software each a "Larger Work" to which the Software
 * is contributed by such licensors),
 *
 * without restriction, including without limitation the rights to copy, create
 * derivative works of, display, perform, and distribute the Software and make,
 * use, sell, offer for sale, import, export, have made, and have sold the
 * Software and the Larger Work(s), and to sublicense the foregoing rights on
 * either these or other terms.
 *
 * This license is subject to the following condition:
 *
 * The above copyright notice and either this complete permission notice or at a
 * minimum a reference to the UPL must be included in all copies or substantial
 * portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package org.pkl.thirdparty.graalvm.polyglot;

import org.pkl.thirdparty.graalvm.polyglot.Context.Builder;

/**
 * Represents an access policy to the process environment for the guest languages of a context.
 *
 * @since 19.1.0
 */
public final class EnvironmentAccess {

    /**
     * Provides guest languages no access to process environment. No environment variables are
     * visible for reading. The {@code NONE} is a default value for {@link Context}s created without
     * {@link Builder#allowAllAccess(boolean) all access}.
     *
     * @since 19.1.0
     */
    public static final EnvironmentAccess NONE = new EnvironmentAccess("NONE");

    /**
     * Provides guest languages read access to process environment. The {@code INHERIT} is a default
     * value for {@link Context}s created with {@link Builder#allowAllAccess(boolean) all access}
     * set to {@code true}.
     *
     * @since 19.1.0
     */
    public static final EnvironmentAccess INHERIT = new EnvironmentAccess("INHERIT");

    private final String name;

    private EnvironmentAccess(String name) {
        this.name = name;
    }

    /**
     * {@inheritDoc}
     *
     * @since 22.3
     */
    @Override
    public String toString() {
        return name;
    }

}