1 /*
   2  * Copyright (c) 2012, 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.  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 
  26 package java.lang.invoke;
  27 
  28 import java.lang.reflect.*;
  29 import java.util.*;
  30 import java.lang.invoke.MethodHandleNatives.Constants;
  31 import java.lang.invoke.MethodHandles.Lookup;
  32 import static java.lang.invoke.MethodHandleStatics.*;
  33 
  34 /**
  35  * A symbolic reference obtained by cracking a direct method handle
  36  * into its consitutent symbolic parts.
  37  * To crack a direct method handle, call {@link Lookup#revealDirect Lookup.revealDirect}.
  38  * <h1><a name="directmh"></a>Direct Method Handles</h1>
  39  * A <em>direct method handle</em> represents a method, constructor, or field without
  40  * any intervening argument bindings or other transformations.
  41  * The method, constructor, or field referred to by a direct method handle is called
  42  * its <em>underlying member</em>.
  43  * Direct method handles may be obtained in any of these ways:
  44  * <ul>
  45  * <li>By executing an {@code ldc} instruction on a {@code CONSTANT_MethodHandle} constant.
  46  *     (See the Java Virtual Machine Specification, sections 4.4.8 and 5.4.3.)
  47  * <li>By calling one of the <a href="MethodHandles.Lookup.html#lookups">Lookup Factory Methods</a>,
  48  *     such as {@link Lookup#findVirtual Lookup.findVirtual},
  49  *     to resolve a symbolic reference into a method handle.
  50  *     A symbolic reference consists of a class, name string, and type.
  51  * <li>By calling the factory method {@link Lookup#unreflect Lookup.unreflect}
  52  *     or {@link Lookup#unreflectSpecial Lookup.unreflectSpecial}
  53  *     to convert a {@link Method} into a method handle.
  54  * <li>By calling the factory method {@link Lookup#unreflectConstructor Lookup.unreflectConstructor}
  55  *     to convert a {@link Constructor} into a method handle.
  56  * <li>By calling the factory method {@link Lookup#unreflectGetter Lookup.unreflectGetter}
  57  *     or {@link Lookup#unreflectSetter Lookup.unreflectSetter}
  58  *     to convert a {@link Field} into a method handle.
  59  * </ul>
  60  *
  61  * <h1>Restrictions on Cracking</h1>
  62  * Given a suitable {@code Lookup} object, it is possible to crack any direct method handle
  63  * to recover a symbolic reference for the underlying method, constructor, or field.
  64  * Cracking must be done via a {@code Lookup} object equivalent to that which created
  65  * the target method handle, or which has enough access permissions to recreate
  66  * an equivalent method handle.
  67  * <p>
  68  * If the underlying method is <a href="MethodHandles.Lookup.html#callsens">caller sensitive</a>,
  69  * the direct method handle will have been "bound" to a particular caller class, the
  70  * {@linkplain java.lang.invoke.MethodHandles.Lookup#lookupClass() lookup class}
  71  * of the lookup object used to create it.
  72  * Cracking this method handle with a different lookup class will fail
  73  * even if the underlying method is public (like {@code Class.forName}).
  74  * <p>
  75  * The requirement of lookup object matching provides a "fast fail" behavior
  76  * for programs which may otherwise trust erroneous revelation of a method
  77  * handle with symbolic information (or caller binding) from an unexpected scope.
  78  * Use {@link java.lang.invoke.MethodHandles#reflectAs} to override this limitation.
  79  *
  80  * <h1><a name="refkinds"></a>Reference kinds</h1>
  81  * The <a href="MethodHandles.Lookup.html#lookups">Lookup Factory Methods</a>
  82  * correspond to all major use cases for methods, constructors, and fields.
  83  * These use cases may be distinguished using small integers as follows:
  84  * <table border=1 cellpadding=5 summary="reference kinds">
  85  * <tr><th>reference kind</th><th>descriptive name</th><th>scope</th><th>member</th><th>behavior</th></tr>
  86  * <tr>
  87  *     <td>{@code 1}</td><td>{@code REF_getField}</td><td>{@code class}</td>
  88  *     <td>{@code FT f;}</td><td>{@code (T) this.f;}</td>
  89  * </tr>
  90  * <tr>
  91  *     <td>{@code 2}</td><td>{@code REF_getStatic}</td><td>{@code class} or {@code interface}</td>
  92  *     <td>{@code static}<br>{@code FT f;}</td><td>{@code (T) C.f;}</td>
  93  * </tr>
  94  * <tr>
  95  *     <td>{@code 3}</td><td>{@code REF_putField}</td><td>{@code class}</td>
  96  *     <td>{@code FT f;}</td><td>{@code this.f = x;}</td>
  97  * </tr>
  98  * <tr>
  99  *     <td>{@code 4}</td><td>{@code REF_putStatic}</td><td>{@code class}</td>
 100  *     <td>{@code static}<br>{@code FT f;}</td><td>{@code C.f = arg;}</td>
 101  * </tr>
 102  * <tr>
 103  *     <td>{@code 5}</td><td>{@code REF_invokeVirtual}</td><td>{@code class}</td>
 104  *     <td>{@code T m(A*);}</td><td>{@code (T) this.m(arg*);}</td>
 105  * </tr>
 106  * <tr>
 107  *     <td>{@code 6}</td><td>{@code REF_invokeStatic}</td><td>{@code class} or {@code interface}</td>
 108  *     <td>{@code static}<br>{@code T m(A*);}</td><td>{@code (T) C.m(arg*);}</td>
 109  * </tr>
 110  * <tr>
 111  *     <td>{@code 7}</td><td>{@code REF_invokeSpecial}</td><td>{@code class} or {@code interface}</td>
 112  *     <td>{@code T m(A*);}</td><td>{@code (T) super.m(arg*);}</td>
 113  * </tr>
 114  * <tr>
 115  *     <td>{@code 8}</td><td>{@code REF_newInvokeSpecial}</td><td>{@code class}</td>
 116  *     <td>{@code C(A*);}</td><td>{@code new C(arg*);}</td>
 117  * </tr>
 118  * <tr>
 119  *     <td>{@code 9}</td><td>{@code REF_invokeInterface}</td><td>{@code interface}</td>
 120  *     <td>{@code T m(A*);}</td><td>{@code (T) this.m(arg*);}</td>
 121  * </tr>
 122  * </table>
 123  * @since 1.8
 124  */
 125 public
 126 interface MethodHandleInfo {
 127     /**
 128      * A direct method handle reference kind,
 129      * as defined in the <a href="MethodHandleInfo.html#refkinds">table above</a>.
 130      */
 131     public static final int
 132         REF_getField                = Constants.REF_getField,
 133         REF_getStatic               = Constants.REF_getStatic,
 134         REF_putField                = Constants.REF_putField,
 135         REF_putStatic               = Constants.REF_putStatic,
 136         REF_invokeVirtual           = Constants.REF_invokeVirtual,
 137         REF_invokeStatic            = Constants.REF_invokeStatic,
 138         REF_invokeSpecial           = Constants.REF_invokeSpecial,
 139         REF_newInvokeSpecial        = Constants.REF_newInvokeSpecial,
 140         REF_invokeInterface         = Constants.REF_invokeInterface;
 141 
 142     /**
 143      * Returns the reference kind of the cracked method handle, which in turn
 144      * determines whether the method handle's underlying member was a constructor, method, or field.
 145      * See the <a href="MethodHandleInfo.html#refkinds">table above</a> for definitions.
 146      * @return the integer code for the kind of reference used to access the underlying member
 147      */
 148     public int getReferenceKind();
 149 
 150     /**
 151      * Returns the class in which the cracked method handle's underlying member was defined.
 152      * @return the declaring class of the underlying member
 153      */
 154     public Class<?> getDeclaringClass();
 155 
 156     /**
 157      * Returns the name of the cracked method handle's underlying member.
 158      * This is {@code "&lt;init&gt;"} if the underlying member was a constructor,
 159      * else it is a simple method name or field name.
 160      * @return the simple name of the underlying member
 161      */
 162     public String getName();
 163 
 164     /**
 165      * Returns the nominal type of the cracked symbolic reference, expressed as a method type.
 166      * If the reference is to a constructor, the return type will be {@code void}.
 167      * If it is to a non-static method, the method type will not mention the {@code this} parameter.
 168      * If it is to a field and the requested access is to read the field,
 169      * the method type will have no parameters and return the field type.
 170      * If it is to a field and the requested access is to write the field,
 171      * the method type will have one parameter of the field type and return {@code void}.
 172      * <p>
 173      * Note that original direct method handle may include a leading {@code this} parameter,
 174      * or (in the case of a constructor) will replace the {@code void} return type
 175      * with the constructed class.
 176      * The nominal type does not include any {@code this} parameter,
 177      * and (in the case of a constructor) will return {@code void}.
 178      * @return the type of the underlying member, expressed as a method type
 179      */
 180     public MethodType getMethodType();
 181 
 182     // Utility methods.
 183     // NOTE: class/name/type and reference kind constitute a symbolic reference
 184     // member and modifiers are an add-on, derived from Core Reflection (or the equivalent)
 185 
 186     /**
 187      * Reflects the underlying member as a method, constructor, or field object.
 188      * If the underlying member is public, it is reflected as if by
 189      * {@code getMethod}, {@code getConstructor}, or {@code getField}.
 190      * Otherwise, it is reflected as if by
 191      * {@code getDeclaredMethod}, {@code getDeclaredConstructor}, or {@code getDeclaredField}.
 192      * The underlying member must be accessible to the given lookup object.
 193      * @param <T> the desired type of the result, either {@link Member} or a subtype
 194      * @param expected a class object representing the desired result type {@code T}
 195      * @param lookup the lookup object that created this MethodHandleInfo, or one with equivalent access privileges
 196      * @return a reference to the method, constructor, or field object
 197      * @exception ClassCastException if the member is not of the expected type
 198      * @exception NullPointerException if either argument is {@code null}
 199      * @exception IllegalArgumentException if the underlying member is not accessible to the given lookup object
 200      */
 201     public <T extends Member> T reflectAs(Class<T> expected, Lookup lookup);
 202 
 203     /**
 204      * Returns the access modifiers of the underlying member.
 205      * @return the Java language modifiers for underlying member,
 206      *         or -1 if the member cannot be accessed
 207      * @see Modifier
 208      * @see #reflectAs
 209      */
 210     public int getModifiers();
 211 
 212     /**
 213      * Determines if the underlying member was a variable arity method or constructor.
 214      * Such members are represented by method handles that are varargs collectors.
 215      * @implSpec
 216      * This produces a result equivalent to:
 217      * <pre>{@code
 218      *     getReferenceKind() >= REF_invokeVirtual && Modifier.isTransient(getModifiers())
 219      * }</pre>
 220      *
 221      *
 222      * @return {@code true} if and only if the underlying member was declared with variable arity.
 223      */
 224     // spelling derived from java.lang.reflect.Executable, not MethodHandle.isVarargsCollector
 225     public default boolean isVarArgs()  {
 226         // fields are never varargs:
 227         if (MethodHandleNatives.refKindIsField((byte) getReferenceKind()))
 228             return false;
 229         // not in the public API: Modifier.VARARGS
 230         final int ACC_VARARGS = 0x00000080;  // from JVMS 4.6 (Table 4.20)
 231         assert(ACC_VARARGS == Modifier.TRANSIENT);
 232         return Modifier.isTransient(getModifiers());
 233     }
 234 
 235     /**
 236      * Returns the descriptive name of the given reference kind,
 237      * as defined in the <a href="MethodHandleInfo.html#refkinds">table above</a>.
 238      * The conventional prefix "REF_" is omitted.
 239      * @param referenceKind an integer code for a kind of reference used to access a class member
 240      * @return a mixed-case string such as {@code "getField"}
 241      * @exception IllegalArgumentException if the argument is not a valid
 242      *            <a href="MethodHandleInfo.html#refkinds">reference kind number</a>
 243      */
 244     public static String referenceKindToString(int referenceKind) {
 245         if (!MethodHandleNatives.refKindIsValid(referenceKind))
 246             throw newIllegalArgumentException("invalid reference kind", referenceKind);
 247         return MethodHandleNatives.refKindName((byte)referenceKind);
 248     }
 249 
 250     /**
 251      * Returns a string representation for a {@code MethodHandleInfo},
 252      * given the four parts of its symbolic reference.
 253      * This is defined to be of the form {@code "RK C.N:MT"}, where {@code RK} is the
 254      * {@linkplain #referenceKindToString reference kind string} for {@code kind},
 255      * {@code C} is the {@linkplain java.lang.Class#getName name} of {@code defc}
 256      * {@code N} is the {@code name}, and
 257      * {@code MT} is the {@code type}.
 258      * These four values may be obtained from the
 259      * {@linkplain #getReferenceKind reference kind},
 260      * {@linkplain #getDeclaringClass declaring class},
 261      * {@linkplain #getName member name},
 262      * and {@linkplain #getMethodType method type}
 263      * of a {@code MethodHandleInfo} object.
 264      *
 265      * @implSpec
 266      * This produces a result equivalent to:
 267      * <pre>{@code
 268      *     String.format("%s %s.%s:%s", referenceKindToString(kind), defc.getName(), name, type)
 269      * }</pre>
 270      *
 271      * @param kind the {@linkplain #getReferenceKind reference kind} part of the symbolic reference
 272      * @param defc the {@linkplain #getDeclaringClass declaring class} part of the symbolic reference
 273      * @param name the {@linkplain #getName member name} part of the symbolic reference
 274      * @param type the {@linkplain #getMethodType method type} part of the symbolic reference
 275      * @return a string of the form {@code "RK C.N:MT"}
 276      * @exception IllegalArgumentException if the first argument is not a valid
 277      *            <a href="MethodHandleInfo.html#refkinds">reference kind number</a>
 278      * @exception NullPointerException if any reference argument is {@code null}
 279      */
 280     public static String toString(int kind, Class<?> defc, String name, MethodType type) {
 281         Objects.requireNonNull(name); Objects.requireNonNull(type);
 282         return String.format("%s %s.%s:%s", referenceKindToString(kind), defc.getName(), name, type);
 283     }
 284 }