1 /*

     2  * Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.

     3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

     4  *

     5  * This code is free software; you can redistribute it and/or modify it

     6  * under the terms of the GNU General Public License version 2 only, as

     7  * published by the Free Software Foundation.  Oracle designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * by Oracle in the LICENSE file that accompanied this code.

    10  *

    11  * This code is distributed in the hope that it will be useful, but WITHOUT

    12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or

    13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License

    14  * version 2 for more details (a copy is included in the LICENSE file that

    15  * accompanied this code).

    16  *

    17  * You should have received a copy of the GNU General Public License version

    18  * 2 along with this work; if not, write to the Free Software Foundation,

    19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

    20  *

    21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA

    22  * or visit www.oracle.com if you need additional information or have any

    23  * questions.

    24  */

    25 package org.graalvm.options;

    26 

    27 /**

    28  * Represents a set of option values based on an {@link OptionDescriptor}.

    29  *

    30  * @since 1.0

    31  */

    32 public interface OptionValues {

    33 

    34     /**

    35      * Returns all available options.

    36      *

    37      * @since 1.0

    38      */

    39     OptionDescriptors getDescriptors();

    40 

    41     /**

    42      * Sets the value of {@code optionKey} to {@code value}.

    43      *

    44      * @throws IllegalArgumentException if the given value is not {@link OptionType#validate(Object)

    45      *             validated} by the {@link OptionKey#getType() option type} of the key. Note that

    46      *             the operation succeeds if the option key is not described by any of the

    47      *             associated {@link #getDescriptors() descriptors}.

    48      *

    49      * @since 1.0

    50      */

    51     <T> void set(OptionKey<T> optionKey, T value);

    52 

    53     /**

    54      * Returns the value of a given option. If no value is set or the key is not described by any

    55      * {@link #getDescriptors() descriptors} the {@link OptionType#getDefaultValue() default value}

    56      * of the given key is returned.

    57      *

    58      * @since 1.0

    59      */

    60     <T> T get(OptionKey<T> optionKey);

    61 

    62     /**

    63      * Determines if a value for {@code optionKey} has been {@link #set} in this set of option

    64      * values.

    65      *

    66      * @since 1.0

    67      */

    68     boolean hasBeenSet(OptionKey<?> optionKey);

    69 

    70 }