1 /*
   2  * Copyright (c) 2013, 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.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  */
  23 
  24 
  25 package org.graalvm.compiler.api.replacements;
  26 
  27 import java.lang.reflect.Type;
  28 
  29 /**
  30  * A registry for {@link MethodSubstitution}s.
  31  */
  32 public interface MethodSubstitutionRegistry {
  33 
  34     /**
  35      * Gets the type representing the receiver (i.e., {@code this}) argument in a non-static method.
  36      */
  37     Class<?> getReceiverType();
  38 
  39     /**
  40      * Registers a substitution method.
  41      *
  42      * @param substituteDeclaringClass the class declaring the substitute method
  43      * @param name the name of both the original and substitute method
  44      * @param argumentTypes the argument types of the method. Element 0 of this array must be
  45      *            {@link #getReceiverType()} iff the method is non-static. Upon returning, element 0
  46      *            will have been rewritten to {@code declaringClass}.
  47      */
  48     default void registerMethodSubstitution(Class<?> substituteDeclaringClass, String name, Type... argumentTypes) {
  49         registerMethodSubstitution(substituteDeclaringClass, name, name, argumentTypes);
  50     }
  51 
  52     /**
  53      * Registers a substitution method.
  54      *
  55      * @param substituteDeclaringClass the class declaring the substitute method
  56      * @param name the name of both the original method
  57      * @param substituteName the name of the substitute method
  58      * @param argumentTypes the argument types of the method. Element 0 of this array must be
  59      *            {@link #getReceiverType()} iff the method is non-static. Upon returning, element 0
  60      *            will have been rewritten to {@code declaringClass}.
  61      */
  62     void registerMethodSubstitution(Class<?> substituteDeclaringClass, String name, String substituteName, Type... argumentTypes);
  63 }