jdk/src/share/classes/java/lang/invoke/MethodHandleInfo.java
author rfield
Tue, 03 Sep 2013 21:42:56 -0700
changeset 19804 83170920c07b
parent 16030 265a0d86c9ff
child 20534 da86f7904e6d
permissions -rw-r--r--
8008688: Make MethodHandleInfo public Summary: A major overhaul to MethodHandleInfo and method handles in general. Reviewed-by: vlivanov, twisti Contributed-by: john.r.rose@oracle.com
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
13423
17843fff200d 7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
diff changeset
     1
/*
16030
265a0d86c9ff 7087570: java.lang.invoke.MemberName information wrong for method handles created with findConstructor
kmo
parents: 16001
diff changeset
     2
 * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
13423
17843fff200d 7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
17843fff200d 7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
diff changeset
     4
 *
17843fff200d 7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
17843fff200d 7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
17843fff200d 7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
17843fff200d 7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
17843fff200d 7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
17843fff200d 7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
diff changeset
    10
 *
17843fff200d 7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
17843fff200d 7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
17843fff200d 7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
17843fff200d 7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
17843fff200d 7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
diff changeset
    15
 * accompanied this code).
17843fff200d 7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
diff changeset
    16
 *
17843fff200d 7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
17843fff200d 7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
17843fff200d 7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
17843fff200d 7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
diff changeset
    20
 *
17843fff200d 7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
17843fff200d 7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
17843fff200d 7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
diff changeset
    23
 * questions.
17843fff200d 7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
diff changeset
    24
 */
17843fff200d 7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
diff changeset
    25
17843fff200d 7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
diff changeset
    26
package java.lang.invoke;
19804
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    27
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    28
import java.lang.reflect.*;
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    29
import java.util.*;
13423
17843fff200d 7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
diff changeset
    30
import java.lang.invoke.MethodHandleNatives.Constants;
19804
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    31
import java.lang.invoke.MethodHandles.Lookup;
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    32
import static java.lang.invoke.MethodHandleStatics.*;
13423
17843fff200d 7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
diff changeset
    33
16001
fd4c8d3becf8 8004970: Implement serialization in the lambda metafactory
rfield
parents: 13423
diff changeset
    34
/**
19804
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    35
 * A symbolic reference obtained by cracking a method handle into its consitutent symbolic parts.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    36
 * To crack a direct method handle, call {@link Lookup#revealDirect Lookup.revealDirect}.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    37
 * <p>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    38
 * A <em>direct method handle</em> represents a method, constructor, or field without
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    39
 * any intervening argument bindings or other transformations.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    40
 * The method, constructor, or field referred to by a direct method handle is called
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    41
 * its <em>underlying member</em>.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    42
 * Direct method handles may be obtained in any of these ways:
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    43
 * <ul>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    44
 * <li>By executing an {@code ldc} instruction on a {@code CONSTANT_MethodHandle} constant.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    45
 *     (See the Java Virtual Machine Specification, sections 4.4.8 and 5.4.3.)
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    46
 * <li>By calling one of the <a href="MethodHandles.Lookup.html#lookups">Lookup Factory Methods</a>,
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    47
 *     such as {@link Lookup#findVirtual Lookup.findVirtual},
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    48
 *     to resolve a symbolic reference into a method handle.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    49
 *     A symbolic reference consists of a class, name string, and type.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    50
 * <li>By calling the factory method {@link Lookup#unreflect Lookup.unreflect}
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    51
 *     or {@link Lookup#unreflectSpecial Lookup.unreflectSpecial}
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    52
 *     to convert a {@link Method} into a method handle.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    53
 * <li>By calling the factory method {@link Lookup#unreflectConstructor Lookup.unreflectConstructor}
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    54
 *     to convert a {@link Constructor} into a method handle.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    55
 * <li>By calling the factory method {@link Lookup#unreflectGetter Lookup.unreflectGetter}
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    56
 *     or {@link Lookup#unreflectSetter Lookup.unreflectSetter}
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    57
 *     to convert a {@link Field} into a method handle.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    58
 * </ul>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    59
 * In all of these cases, it is possible to crack the resulting direct method handle
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    60
 * to recover a symbolic reference for the underlying method, constructor, or field.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    61
 * Cracking must be done via a {@code Lookup} object equivalent to that which created
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    62
 * the target method handle, or which has enough access permissions to recreate
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    63
 * an equivalent method handle.
16001
fd4c8d3becf8 8004970: Implement serialization in the lambda metafactory
rfield
parents: 13423
diff changeset
    64
 *
19804
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    65
 * <h1><a name="refkinds"></a>Reference kinds</h1>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    66
 * The <a href="MethodHandles.Lookup.html#lookups">Lookup Factory Methods</a>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    67
 * correspond to all major use cases for methods, constructors, and fields.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    68
 * These use cases may be distinguished using small integers as follows:
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    69
 * <table border=1 cellpadding=5 summary="reference kinds">
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    70
 * <tr><th>reference kind</th><th>descriptive name</th><th>scope</th><th>member</th><th>behavior</th></tr>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    71
 * <tr>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    72
 *     <td>{@code 1}</td><td>{@code REF_getField}</td><td>{@code class}</td>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    73
 *     <td>{@code FT f;}</td><td>{@code (T) this.f;}</td>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    74
 * </tr>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    75
 * <tr>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    76
 *     <td>{@code 2}</td><td>{@code REF_getStatic}</td><td>{@code class} or {@code interface}</td>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    77
 *     <td>{@code static}<br>{@code FT f;}</td><td>{@code (T) C.f;}</td>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    78
 * </tr>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    79
 * <tr>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    80
 *     <td>{@code 3}</td><td>{@code REF_putField}</td><td>{@code class}</td>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    81
 *     <td>{@code FT f;}</td><td>{@code this.f = x;}</td>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    82
 * </tr>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    83
 * <tr>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    84
 *     <td>{@code 4}</td><td>{@code REF_putStatic}</td><td>{@code class}</td>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    85
 *     <td>{@code static}<br>{@code FT f;}</td><td>{@code C.f = arg;}</td>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    86
 * </tr>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    87
 * <tr>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    88
 *     <td>{@code 5}</td><td>{@code REF_invokeVirtual}</td><td>{@code class}</td>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    89
 *     <td>{@code T m(A*);}</td><td>{@code (T) this.m(arg*);}</td>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    90
 * </tr>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    91
 * <tr>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    92
 *     <td>{@code 6}</td><td>{@code REF_invokeStatic}</td><td>{@code class} or {@code interface}</td>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    93
 *     <td>{@code static}<br>{@code T m(A*);}</td><td>{@code (T) C.m(arg*);}</td>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    94
 * </tr>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    95
 * <tr>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    96
 *     <td>{@code 7}</td><td>{@code REF_invokeSpecial}</td><td>{@code class} or {@code interface}</td>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    97
 *     <td>{@code T m(A*);}</td><td>{@code (T) super.m(arg*);}</td>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    98
 * </tr>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
    99
 * <tr>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   100
 *     <td>{@code 8}</td><td>{@code REF_newInvokeSpecial}</td><td>{@code class}</td>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   101
 *     <td>{@code C(A*);}</td><td>{@code new C(arg*);}</td>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   102
 * </tr>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   103
 * <tr>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   104
 *     <td>{@code 9}</td><td>{@code REF_invokeInterface}</td><td>{@code interface}</td>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   105
 *     <td>{@code T m(A*);}</td><td>{@code (T) this.m(arg*);}</td>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   106
 * </tr>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   107
 * </table>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   108
 * @since 1.8
16001
fd4c8d3becf8 8004970: Implement serialization in the lambda metafactory
rfield
parents: 13423
diff changeset
   109
 */
19804
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   110
public
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   111
interface MethodHandleInfo {
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   112
    /**
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   113
     * A direct method handle reference kind,
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   114
     * as defined in the <a href="MethodHandleInfo.html#refkinds">table above</a>.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   115
     */
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   116
    public static final int
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   117
        REF_getField                = Constants.REF_getField,
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   118
        REF_getStatic               = Constants.REF_getStatic,
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   119
        REF_putField                = Constants.REF_putField,
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   120
        REF_putStatic               = Constants.REF_putStatic,
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   121
        REF_invokeVirtual           = Constants.REF_invokeVirtual,
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   122
        REF_invokeStatic            = Constants.REF_invokeStatic,
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   123
        REF_invokeSpecial           = Constants.REF_invokeSpecial,
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   124
        REF_newInvokeSpecial        = Constants.REF_newInvokeSpecial,
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   125
        REF_invokeInterface         = Constants.REF_invokeInterface;
13423
17843fff200d 7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
diff changeset
   126
19804
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   127
    /**
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   128
     * Returns the reference kind of the cracked method handle, which in turn
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   129
     * determines whether the method handle's underlying member was a constructor, method, or field.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   130
     * See the <a href="MethodHandleInfo.html#refkinds">table above</a> for definitions.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   131
     * @return the integer code for the kind of reference used to access the underlying member
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   132
     */
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   133
    public int getReferenceKind();
13423
17843fff200d 7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
diff changeset
   134
19804
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   135
    /**
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   136
     * Returns the class in which the cracked method handle's underlying member was defined.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   137
     * @return the declaring class of the underlying member
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   138
     */
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   139
    public Class<?> getDeclaringClass();
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   140
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   141
    /**
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   142
     * Returns the name of the cracked method handle's underlying member.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   143
     * This is {@code "&lt;init&gt;"} if the underlying member was a constructor,
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   144
     * else it is a simple method name or field name.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   145
     * @return the simple name of the underlying member
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   146
     */
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   147
    public String getName();
13423
17843fff200d 7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
diff changeset
   148
19804
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   149
    /**
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   150
     * Returns the nominal type of the cracked symbolic reference, expressed as a method type.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   151
     * If the reference is to a constructor, the return type will be {@code void}.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   152
     * If it is to a non-static method, the method type will not mention the {@code this} parameter.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   153
     * If it is to a field and the requested access is to read the field,
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   154
     * the method type will have no parameters and return the field type.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   155
     * If it is to a field and the requested access is to write the field,
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   156
     * the method type will have one parameter of the field type and return {@code void}.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   157
     * <p>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   158
     * Note that original direct method handle may include a leading {@code this} parameter,
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   159
     * or (in the case of a constructor) will replace the {@code void} return type
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   160
     * with the constructed class.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   161
     * The nominal type does not include any {@code this} parameter,
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   162
     * and (in the case of a constructor) will return {@code void}.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   163
     * @return the type of the underlying member, expressed as a method type
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   164
     */
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   165
    public MethodType getMethodType();
13423
17843fff200d 7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
diff changeset
   166
19804
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   167
    // Utility methods.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   168
    // NOTE: class/name/type and reference kind constitute a symbolic reference
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   169
    // member and modifiers are an add-on, derived from Core Reflection (or the equivalent)
16001
fd4c8d3becf8 8004970: Implement serialization in the lambda metafactory
rfield
parents: 13423
diff changeset
   170
19804
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   171
    /**
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   172
     * Reflects the underlying member as a method, constructor, or field object.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   173
     * If the underlying member is public, it is reflected as if by
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   174
     * {@code getMethod}, {@code getConstructor}, or {@code getField}.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   175
     * Otherwise, it is reflected as if by
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   176
     * {@code getDeclaredMethod}, {@code getDeclaredConstructor}, or {@code getDeclaredField}.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   177
     * The underlying member must be accessible to the given lookup object.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   178
     * @param <T> the desired type of the result, either {@link Member} or a subtype
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   179
     * @param expected a class object representing the desired result type {@code T}
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   180
     * @param lookup the lookup object that created this MethodHandleInfo, or one with equivalent access privileges
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   181
     * @return a reference to the method, constructor, or field object
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   182
     * @exception ClassCastException if the member is not of the expected type
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   183
     * @exception NullPointerException if either argument is {@code null}
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   184
     * @exception IllegalArgumentException if the underlying member is not accessible to the given lookup object
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   185
     */
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   186
    public <T extends Member> T reflectAs(Class<T> expected, Lookup lookup);
16001
fd4c8d3becf8 8004970: Implement serialization in the lambda metafactory
rfield
parents: 13423
diff changeset
   187
19804
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   188
    /**
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   189
     * Returns the access modifiers of the underlying member.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   190
     * @return the Java language modifiers for underlying member,
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   191
     *         or -1 if the member cannot be accessed
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   192
     * @see Modifier
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   193
     * @see reflectAs
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   194
     */
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   195
    public int getModifiers();
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   196
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   197
    /**
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   198
     * Determines if the underlying member was a variable arity method or constructor.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   199
     * Such members are represented by method handles that are varargs collectors.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   200
     * @implSpec
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   201
     * This produces a result equivalent to:
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   202
     * <pre>{@code
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   203
     *     getReferenceKind() >= REF_invokeVirtual && Modifier.isTransient(getModifiers())
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   204
     * }</pre>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   205
     *
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   206
     *
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   207
     * @return {@code true} if and only if the underlying member was declared with variable arity.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   208
     */
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   209
    // spelling derived from java.lang.reflect.Executable, not MethodHandle.isVarargsCollector
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   210
    public default boolean isVarArgs()  {
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   211
        // fields are never varargs:
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   212
        if (MethodHandleNatives.refKindIsField((byte) getReferenceKind()))
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   213
            return false;
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   214
        // not in the public API: Modifier.VARARGS
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   215
        final int ACC_VARARGS = 0x00000080;  // from JVMS 4.6 (Table 4.20)
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   216
        assert(ACC_VARARGS == Modifier.TRANSIENT);
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   217
        return Modifier.isTransient(getModifiers());
16001
fd4c8d3becf8 8004970: Implement serialization in the lambda metafactory
rfield
parents: 13423
diff changeset
   218
    }
fd4c8d3becf8 8004970: Implement serialization in the lambda metafactory
rfield
parents: 13423
diff changeset
   219
19804
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   220
    /**
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   221
     * Returns the descriptive name of the given reference kind,
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   222
     * as defined in the <a href="MethodHandleInfo.html#refkinds">table above</a>.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   223
     * The conventional prefix "REF_" is omitted.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   224
     * @param referenceKind an integer code for a kind of reference used to access a class member
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   225
     * @return a mixed-case string such as {@code "getField"}
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   226
     * @exception IllegalArgumentException if the argument is not a valid
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   227
     *            <a href="MethodHandleInfo.html#refkinds">reference kind number</a>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   228
     */
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   229
    public static String referenceKindToString(int referenceKind) {
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   230
        if (!MethodHandleNatives.refKindIsValid(referenceKind))
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   231
            throw newIllegalArgumentException("invalid reference kind", referenceKind);
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   232
        return MethodHandleNatives.refKindName((byte)referenceKind);
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   233
    }
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   234
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   235
    /**
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   236
     * Returns a string representation for a {@code MethodHandleInfo},
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   237
     * given the four parts of its symbolic reference.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   238
     * This is defined to be of the form {@code "RK C.N:MT"}, where {@code RK} is the
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   239
     * {@linkplain #referenceKindToString reference kind string} for {@code kind},
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   240
     * {@code C} is the {@linkplain java.lang.Class#getName name} of {@code defc}
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   241
     * {@code N} is the {@code name}, and
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   242
     * {@code MT} is the {@code type}.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   243
     * These four values may be obtained from the
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   244
     * {@linkplain #getReferenceKind reference kind},
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   245
     * {@linkplain #getDeclaringClass declaring class},
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   246
     * {@linkplain #getName member name},
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   247
     * and {@linkplain #getMethodType method type}
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   248
     * of a {@code MethodHandleInfo} object.
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   249
     *
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   250
     * @implSpec
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   251
     * This produces a result equivalent to:
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   252
     * <pre>{@code
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   253
     *     String.format("%s %s.%s:%s", referenceKindToString(kind), defc.getName(), name, type)
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   254
     * }</pre>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   255
     *
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   256
     * @param kind the {@linkplain #getReferenceKind reference kind} part of the symbolic reference
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   257
     * @param defc the {@linkplain #getDeclaringClass declaring class} part of the symbolic reference
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   258
     * @param name the {@linkplain #getName member name} part of the symbolic reference
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   259
     * @param type the {@linkplain #getMethodType method type} part of the symbolic reference
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   260
     * @return a string of the form {@code "RK C.N:MT"}
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   261
     * @exception IllegalArgumentException if the first argument is not a valid
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   262
     *            <a href="MethodHandleInfo.html#refkinds">reference kind number</a>
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   263
     * @exception NullPointerException if any reference argument is {@code null}
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   264
     */
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   265
    public static String toString(int kind, Class<?> defc, String name, MethodType type) {
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   266
        Objects.requireNonNull(name); Objects.requireNonNull(type);
83170920c07b 8008688: Make MethodHandleInfo public
rfield
parents: 16030
diff changeset
   267
        return String.format("%s %s.%s:%s", referenceKindToString(kind), defc.getName(), name, type);
16001
fd4c8d3becf8 8004970: Implement serialization in the lambda metafactory
rfield
parents: 13423
diff changeset
   268
    }
13423
17843fff200d 7023639: JSR 292 method handle invocation needs a fast path for compiled code
twisti
parents:
diff changeset
   269
}