/*
 * Copyright (c) 2017, 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 com.oracle.svm.core.option;

import org.graalvm.compiler.api.replacements.Fold;
import org.graalvm.compiler.options.Option;
import org.graalvm.compiler.options.OptionKey;

Defines a hosted Option that is used during native image generation, in contrast to a runtime option. 
See Also:
option/**
 * Defines a hosted {@link Option} that is used during native image generation, in contrast to a
 * {@link RuntimeOptionKey runtime option}.
 *
 * @see com.oracle.svm.core.option
 */
public class HostedOptionKey<T> extends OptionKey<T> {

    public HostedOptionKey(T defaultValue) {
        super(defaultValue);
    }

    
Returns the value of this option in the HostedOptionValues. 
 The result of this method is guaranteed to be constant folded in the native image due to the Fold annotation. /**
     * Returns the value of this option in the {@link HostedOptionValues}.
     * <p>
     * The result of this method is guaranteed to be constant folded in the native image due to the
     * {@link Fold} annotation.
     */
    @Fold
    public T getValue() {
        return getValue(HostedOptionValues.singleton());
    }

    
Returns true if this option has been set in the HostedOptionValues. 
 The result of this method is guaranteed to be constant folded in the native image due to the Fold annotation. /**
     * Returns {@code true} if this option has been set in the {@link HostedOptionValues}.
     * <p>
     * The result of this method is guaranteed to be constant folded in the native image due to the
     * {@link Fold} annotation.
     */
    @Fold
    public boolean hasBeenSet() {
        return hasBeenSet(HostedOptionValues.singleton());
    }

    
Descriptors are not loaded for HostedOptionKey. /**
     * Descriptors are not loaded for {@link HostedOptionKey}.
     */
    @Override
    protected boolean checkDescriptorExists() {
        return true;
    }
}