/* * Copyright (c) 2014, 2018, 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. * * 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.compiler.api.replacements; import java.util.Objects; import jdk.vm.ci.meta.JavaConstant; import jdk.vm.ci.meta.JavaKind; import jdk.vm.ci.meta.ResolvedJavaType; /** * Reflection operations on values represented as {@linkplain JavaConstant constants} for the * processing of snippets. Snippets need a direct access to the value of object constants, which is * not allowed in other parts of Graal to enforce compiler-VM separation. *
* This interface must not be used in Graal code that is not related to snippet processing.
*/
public interface SnippetReflectionProvider {
/**
* Creates a boxed {@link JavaKind#Object object} constant.
*
* @param object the object value to box
* @return a constant containing {@code object}
*/
JavaConstant forObject(Object object);
/**
* Gets the object reference a given constant represents if it is of a given type. The constant
* must have kind {@link JavaKind#Object}.
*
* @param type the expected type of the object represented by {@code constant}. If the object is
* required to be of this type, then wrap the call to this method in
* {@link Objects#requireNonNull(Object)}.
* @param constant an object constant
* @return the object value represented by {@code constant} cast to {@code type} if it is an
* {@link Class#isInstance(Object) instance of} {@code type} otherwise {@code null}
*/