org.graalvm.options.OptionValues Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of graal-sdk Show documentation

GraalVM is an ecosystem for compiling and running applications written in multiple languages. GraalVM removes the isolation between programming languages and enables interoperability in a shared runtime.

There is a newer version: 1.0.0-rc7

Show newest version

/*
 * Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */
package org.graalvm.options;

/**
 * Represents a set of option values based on an {@link OptionDescriptor}.
 *
 * @since 1.0
 */
public interface OptionValues {

    /**
     * Returns all available options.
     *
     * @since 1.0
     */
    OptionDescriptors getDescriptors();

    /**
     * Sets the value of {@code optionKey} to {@code value}.
     *
     * @throws IllegalArgumentException if the given value is not {@link OptionType#validate(Object)
     *             validated} by the {@link OptionKey#getType() option type} of the key. Note that
     *             the operation succeeds if the option key is not described by any of the
     *             associated {@link #getDescriptors() descriptors}.
     *
     * @since 1.0
     */
     void set(OptionKey optionKey, T value);

    /**
     * Returns the value of a given option. If no value is set or the key is not described by any
     * {@link #getDescriptors() descriptors} the {@link OptionType#getDefaultValue() default value}
     * of the given key is returned.
     *
     * @since 1.0
     */
     T get(OptionKey optionKey);

    /**
     * Determines if a value for {@code optionKey} has been {@link #set} in this set of option
     * values.
     *
     * @since 1.0
     */
    boolean hasBeenSet(OptionKey optionKey);

    /**
     * Determines if a value for any of the option keys in {@link #getDescriptors() option
     * descriptors} has been {@link #set} in this set of option values.
     *
     * @since 1.0
     */
    default boolean hasSetOptions() {
        for (OptionDescriptor descriptor : getDescriptors()) {
            if (hasBeenSet(descriptor.getKey())) {
                return true;
            }
        }
        return false;
    }

}