001/*
002 * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation.
008 *
009 * This code is distributed in the hope that it will be useful, but WITHOUT
010 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
011 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
012 * version 2 for more details (a copy is included in the LICENSE file that
013 * accompanied this code).
014 *
015 * You should have received a copy of the GNU General Public License version
016 * 2 along with this work; if not, write to the Free Software Foundation,
017 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
018 *
019 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
020 * or visit www.oracle.com if you need additional information or have any
021 * questions.
022 */
023package com.oracle.graal.api.replacements;
024
025import java.lang.annotation.*;
026
027import jdk.internal.jvmci.meta.*;
028
029/**
030 * Denotes a substitute method. A substitute method can call the original/substituted method by
031 * making a recursive call to itself.
032 */
033@Retention(RetentionPolicy.RUNTIME)
034@Target(ElementType.METHOD)
035public @interface MethodSubstitution {
036
037    /**
038     * Gets the name of the original method.
039     * <p>
040     * If the default value is specified for this element, then the name of the original method is
041     * same as the substitute method.
042     */
043    String value() default "";
044
045    /**
046     * Determines if the original method is static.
047     */
048    boolean isStatic() default true;
049
050    /**
051     * Gets the {@linkplain Signature#toMethodDescriptor signature} of the original method.
052     * <p>
053     * If the default value is specified for this element, then the signature of the original method
054     * is the same as the substitute method.
055     */
056    String signature() default "";
057
058    /**
059     * Determines if the substitution is for a method that may not be part of the runtime. For
060     * example, a method introduced in a later JDK version. Substitutions for such methods are
061     * omitted if the original method cannot be found.
062     */
063    boolean optional() default false;
064
065    /**
066     * Determines if the substitution is globally enabled.
067     */
068
069    Class<? extends SubstitutionGuard> guard() default SubstitutionGuard.class;
070}