public abstract classMethodHandleextendsObject
Every method handle reports its type descriptor via thetype accessor. This type descriptor is aMethodType object, whose structure is a series of classes, one of which is the return type of the method (orvoid.class if none).
A method handle's type controls the types of invocations it accepts, and the kinds of transformations that apply to it.
A method handle contains a pair of special invoker methods calledinvokeExact andinvoke. Both invoker methods provide direct access to the method handle's underlying method, constructor, field, or other operation, as modified by transformations of arguments and return values. Both invokers accept calls which exactly match the method handle's own type. The plain, inexact invoker also accepts a range of other call types.
Method handles are immutable and have no visible state. Of course, they can be bound to underlying methods or data which exhibit state. With respect to the Java Memory Model, any method handle will behave as if all of its (internal) fields are final variables. This means that any method handle made visible to the application will always be fully formed. This is true even if the method handle is published through a shared variable in a data race.
Method handles cannot be subclassed by the user. Implementations may (or may not) create internal subclasses ofMethodHandle which may be visible via theObject.getClass operation. The programmer should not draw conclusions about a method handle from its specific class, as the method handle class hierarchy (if any) may change from time to time or across implementations from different vendors.
invokeExact orinvoke can invoke a method handle from Java source code. From the viewpoint of source code, these methods can take any arguments and their result can be cast to any return type. Formally this is accomplished by giving the invoker methodsObject return types and variable arityObject arguments, but they have an additional quality calledsignature polymorphism which connects this freedom of invocation directly to the JVM execution stack. As is usual with virtual methods, source-level calls toinvokeExact andinvoke compile to aninvokevirtual instruction. More unusually, the compiler must record the actual argument types, and may not perform method invocation conversions on the arguments. Instead, it must push them on the stack according to their own unconverted types. The method handle object itself is pushed on the stack before the arguments. The compiler then calls the method handle with a symbolic type descriptor which describes the argument and return types.
To issue a complete symbolic type descriptor, the compiler must also determine the return type. This is based on a cast on the method invocation expression, if there is one, or elseObject if the invocation is an expression or elsevoid if the invocation is a statement. The cast may be to a primitive type (but notvoid).
As a corner case, an uncastednull argument is given a symbolic type descriptor ofjava.lang.Void. The ambiguity with the typeVoid is harmless, since there are no references of typeVoid except the null reference.
invokevirtual instruction is executed it is linked, by symbolically resolving the names in the instruction and verifying that the method call is statically legal. This is true of calls toinvokeExact andinvoke. In this case, the symbolic type descriptor emitted by the compiler is checked for correct syntax and names it contains are resolved. Thus, aninvokevirtual instruction which invokes a method handle will always link, as long as the symbolic type descriptor is syntactically well-formed and the types exist. When theinvokevirtual is executed after linking, the receiving method handle's type is first checked by the JVM to ensure that it matches the symbolic type descriptor. If the type match fails, it means that the method which the caller is invoking is not present on the individual method handle being invoked.
In the case ofinvokeExact, the type descriptor of the invocation (after resolving symbolic type names) must exactly match the method type of the receiving method handle. In the case of plain, inexactinvoke, the resolved type descriptor must be a valid argument to the receiver'sasType method. Thus, plaininvoke is more permissive thaninvokeExact.
After type matching, a call toinvokeExact directly and immediately invoke the method handle's underlying method (or other behavior, as the case may be).
A call to plaininvoke works the same as a call toinvokeExact, if the symbolic type descriptor specified by the caller exactly matches the method handle's own type. If there is a type mismatch,invoke attempts to adjust the type of the receiving method handle, as if by a call toasType, to obtain an exactly invokable method handleM2. This allows a more powerful negotiation of method type between caller and callee.
(Note: The adjusted method handleM2 is not directly observable, and implementations are therefore not required to materialize it.)
WrongMethodTypeException, either directly (in the case ofinvokeExact) or indirectly as if by a failed call toasType (in the case ofinvoke). Thus, a method type mismatch which might show up as a linkage error in a statically typed program can show up as a dynamicWrongMethodTypeException in a program which uses method handles.
Because method types contain "live"Class objects, method type matching takes into account both types names and class loaders. Thus, even if a method handleM is created in one class loaderL1 and used in anotherL2, method handle calls are type-safe, because the caller's symbolic type descriptor, as resolved inL2, is matched against the original callee method's symbolic type descriptor, as resolved inL1. The resolution inL1 happens whenM is created and its type is assigned, while the resolution inL2 happens when theinvokevirtual instruction is linked.
Apart from the checking of type descriptors, a method handle's capability to call its underlying method is unrestricted. If a method handle is formed on a non-public method by a class that has access to that method, the resulting handle can be used in any place by any caller who receives a reference to it.
Unlike with the Core Reflection API, where access is checked every time a reflective method is invoked, method handle access checking is performedwhen the method handle is created. In the case ofldc (see below), access checking is performed as part of linking the constant pool entry underlying the constant method handle.
Thus, handles to non-public methods, or to methods in non-public classes, should generally be kept secret. They should not be passed to untrusted code unless their use from the untrusted code would be harmless.
MethodHandles.Lookup For example, a static method handle can be obtained fromLookup.findStatic. There are also conversion methods from Core Reflection API objects, such asLookup.unreflect. Like classes and strings, method handles that correspond to accessible fields, methods, and constructors can also be represented directly in a class file's constant pool as constants to be loaded byldc bytecodes. A new type of constant pool entry,CONSTANT_MethodHandle, refers directly to an associatedCONSTANT_Methodref,CONSTANT_InterfaceMethodref, orCONSTANT_Fieldref constant pool entry. (For full details on method handle constants, see sections 4.4.8 and 5.4.3.5 of the Java Virtual Machine Specification.)
Method handles produced by lookups or constant loads from methods or constructors with the variable arity modifier bit (0x0080) have a corresponding variable arity, as if they were defined with the help ofasVarargsCollector.
A method reference may refer either to a static or non-static method. In the non-static case, the method handle type includes an explicit receiver argument, prepended before any other arguments. In the method handle's type, the initial receiver argument is typed according to the class under which the method was initially requested. (E.g., if a non-static method handle is obtained vialdc, the type of the receiver is the class named in the constant pool entry.)
Method handle constants are subject to the same link-time access checks their corresponding bytecode instructions, and theldc instruction will throw corresponding linkage errors if the bytecode behaviors would throw such errors.
As a corollary of this, access to protected members is restricted to receivers only of the accessing class, or one of its subclasses, and the accessing class must in turn be a subclass (or package sibling) of the protected member's defining class. If a method reference refers to a protected non-static method or field of a class outside the current package, the receiver argument will be narrowed to the type of the accessing class.
When a method handle to a virtual method is invoked, the method is always looked up in the receiver (that is, the first argument).
A non-virtual method handle to a specific virtual method implementation can also be created. These do not perform virtual lookup based on receiver type. Such a method handle simulates the effect of aninvokespecial instruction to the same method.
Each of the above calls toObject x, y; String s; int i;MethodType mt; MethodHandle mh;MethodHandles.Lookup lookup = MethodHandles.lookup();// mt is (char,char)Stringmt = MethodType.methodType(String.class, char.class, char.class);mh = lookup.findVirtual(String.class, "replace", mt);s = (String) mh.invokeExact("daddy",'d','n');// invokeExact(Ljava/lang/String;CC)Ljava/lang/String;assertEquals(s, "nanny");// weakly typed invocation (using MHs.invoke)s = (String) mh.invokeWithArguments("sappy", 'p', 'v');assertEquals(s, "savvy");// mt is (Object[])Listmt = MethodType.methodType(java.util.List.class, Object[].class);mh = lookup.findStatic(java.util.Arrays.class, "asList", mt);assert(mh.isVarargsCollector());x = mh.invoke("one", "two");// invoke(Ljava/lang/String;Ljava/lang/String;)Ljava/lang/Object;assertEquals(x, java.util.Arrays.asList("one","two"));// mt is (Object,Object,Object)Objectmt = MethodType.genericMethodType(3);mh = mh.asType(mt);x = mh.invokeExact((Object)1, (Object)2, (Object)3);// invokeExact(Ljava/lang/Object;Ljava/lang/Object;Ljava/lang/Object;)Ljava/lang/Object;assertEquals(x, java.util.Arrays.asList(1,2,3));// mt is ()intmt = MethodType.methodType(int.class);mh = lookup.findVirtual(java.util.List.class, "size", mt);i = (int) mh.invokeExact(java.util.Arrays.asList(1,2,3));// invokeExact(Ljava/util/List;)Iassert(i == 3);mt = MethodType.methodType(void.class, String.class);mh = lookup.findVirtual(java.io.PrintStream.class, "println", mt);mh.invokeExact(System.out, "Hello, world.");// invokeExact(Ljava/io/PrintStream;Ljava/lang/String;)V
invokeExact or plaininvoke generates a single invokevirtual instruction with the symbolic type descriptor indicated in the following comment. In these examples, the helper methodassertEquals is assumed to be a method which callsObjects.equals on its arguments, and asserts that the result is true.invokeExact andinvoke are declared to throwThrowable, which is to say that there is no static restriction on what a method handle can throw. Since the JVM does not distinguish between checked and unchecked exceptions (other than by their class, of course), there is no particular effect on bytecode shape from ascribing checked exceptions to method handle invocations. But in Java source code, methods which perform method handle calls must either explicitly throwThrowable, or else must catch all throwables locally, rethrowing only those which are legal in the context, and wrapping ones which are illegal.invokeExact and plaininvoke is referenced by the termsignature polymorphism. As defined in the Java Language Specification, a signature polymorphic method is one which can operate with any of a wide range of call signatures and return types. In source code, a call to a signature polymorphic method will compile, regardless of the requested symbolic type descriptor. As usual, the Java compiler emits aninvokevirtual instruction with the given symbolic type descriptor against the named method. The unusual part is that the symbolic type descriptor is derived from the actual argument and return types, not from the method declaration.
When the JVM processes bytecode containing signature polymorphic calls, it will successfully link any such call, regardless of its symbolic type descriptor. (In order to retain type safety, the JVM will guard such calls with suitable dynamic type checks, as described elsewhere.)
Bytecode generators, including the compiler back end, are required to emit untransformed symbolic type descriptors for these methods. Tools which determine symbolic linkage are required to accept such untransformed descriptors, without reporting linkage errors.
Lookup API, any class member represented by a Core Reflection API object can be converted to a behaviorally equivalent method handle. For example, a reflectiveMethod can be converted to a method handle usingLookup.unreflect. The resulting method handles generally provide more direct and efficient access to the underlying class members. As a special case, when the Core Reflection API is used to view the signature polymorphic methodsinvokeExact or plaininvoke in this class, they appear as ordinary non-polymorphic methods. Their reflective appearance, as viewed byClass.getDeclaredMethod, is unaffected by their special status in this API. For example,Method.getModifiers will report exactly those modifier bits required for any similarly declared method, including in this casenative andvarargs bits.
As with any reflected method, these methods (when reflected) may be invoked viajava.lang.reflect.Method.invoke. However, such reflective calls do not result in method handle invocations. Such a call, if passed the required argument (a single one, of typeObject[]), will ignore the argument and will throw anUnsupportedOperationException.
Sinceinvokevirtual instructions can natively invoke method handles under any symbolic type descriptor, this reflective view conflicts with the normal presentation of these methods via bytecodes. Thus, these two native methods, when reflectively viewed byClass.getDeclaredMethod, may be regarded as placeholders only.
In order to obtain an invoker method for a particular type descriptor, useMethodHandles.exactInvoker, orMethodHandles.invoker. TheLookup.findVirtual API is also able to return a method handle to callinvokeExact or plaininvoke, for any specified type descriptor .
invokevirtual instruction.Method handles do not represent their function-like types in terms of Java parameterized (generic) types, because there are three mismatches between function-like types and parameterized Java types.
long ordouble argument counts (for purposes of arity limits) as two argument slots.invoke method (or other signature-polymorphic method) is non-virtual, it consumes an extra argument for the method handle itself, in addition to any non-virtual receiver object.IllegalArgumentException. In particular, a method handle’s type must not have an arity of the exact maximum 255.MethodType,MethodHandles| Modifier and Type | Method | Description |
|---|---|---|
MethodHandle | asCollector(Class<?> arrayType, int arrayLength) | Makes anarray-collecting method handle, which accepts a given number of trailing positional arguments and collects them into an array argument. |
MethodHandle | asFixedArity() | Makes afixed arity method handle which is otherwise equivalent to the current method handle. |
MethodHandle | asSpreader(Class<?> arrayType, int arrayLength) | Makes anarray-spreading method handle, which accepts a trailing array argument and spreads its elements as positional arguments. |
MethodHandle | asType(MethodType newType) | Produces an adapter method handle which adapts the type of the current method handle to a new type. |
MethodHandle | asVarargsCollector(Class<?> arrayType) | Makes avariable arity adapter which is able to accept any number of trailing positional arguments and collect them into an array argument. |
MethodHandle | bindTo(Object x) | Binds a value x to the first argument of a method handle, without invoking it. |
Object | invoke(Object... args) | Invokes the method handle, allowing any caller type descriptor, and optionally performing conversions on arguments and return values. |
Object | invokeExact(Object... args) | Invokes the method handle, allowing any caller type descriptor, but requiring an exact type match. |
Object | invokeWithArguments(List<?> arguments) | Performs a variable arity invocation, passing the arguments in the given array to the method handle, as if via an inexact invoke from a call site which mentions only the typeObject, and whose arity is the length of the argument array. |
Object | invokeWithArguments(Object... arguments) | Performs a variable arity invocation, passing the arguments in the given list to the method handle, as if via an inexact invoke from a call site which mentions only the typeObject, and whose arity is the length of the argument list. |
boolean | isVarargsCollector() | Determines if this method handle supportsvariable arity calls. |
String | toString() | Returns a string representation of the method handle, starting with the string "MethodHandle" and ending with the string representation of the method handle's type. |
MethodType | type() | Reports the type of this method handle. |
public MethodType type()
invokeExact must exactly match this type.public final Object invokeExact(Object... args) throwsThrowable
invokeExact must exactly match this method handle'stype. No conversions are allowed on arguments or return values. When this method is observed via the Core Reflection API, it will appear as a single native method, taking an object array and returning an object. If this native method is invoked directly viajava.lang.reflect.Method.invoke, via JNI, or indirectly viaLookup.unreflect, it will throw anUnsupportedOperationException.
args - the signature-polymorphic parameter list, statically represented using varargsObjectWrongMethodTypeException - if the target's type is not identical with the caller's symbolic type descriptorThrowable - anything thrown by the underlying method propagates unchanged through the method handle callpublic final Object invoke(Object... args) throwsThrowable
If the call site's symbolic type descriptor exactly matches this method handle'stype, the call proceeds as if byinvokeExact.
Otherwise, the call proceeds as if this method handle were first adjusted by callingasType to adjust this method handle to the required type, and then the call proceeds as if byinvokeExact on the adjusted method handle.
There is no guarantee that theasType call is actually made. If the JVM can predict the results of making the call, it may perform adaptations directly on the caller's arguments, and call the target method handle according to its own exact type.
The resolved type descriptor at the call site ofinvoke must be a valid argument to the receiversasType method. In particular, the caller must specify the same argument arity as the callee's type, if the callee is not avariable arity collector.
When this method is observed via the Core Reflection API, it will appear as a single native method, taking an object array and returning an object. If this native method is invoked directly viajava.lang.reflect.Method.invoke, via JNI, or indirectly viaLookup.unreflect, it will throw anUnsupportedOperationException.
args - the signature-polymorphic parameter list, statically represented using varargsObjectWrongMethodTypeException - if the target's type cannot be adjusted to the caller's symbolic type descriptorClassCastException - if the target's type can be adjusted to the caller, but a reference cast failsThrowable - anything thrown by the underlying method propagates unchanged through the method handle callpublic Object invokeWithArguments(Object... arguments) throwsThrowable
invoke from a call site which mentions only the typeObject, and whose arity is the length of the argument list.Specifically, execution proceeds as if by the following steps, although the methods are not guaranteed to be called if the JVM can predict their effects.
N. For a null reference,N=0.TN ofN arguments as asTN=MethodType.genericMethodType(N).MH0 to the required type, asMH1 = MH0.asType(TN).N separate argumentsA0, ....Object reference. Because of the action of theasType step, the following argument conversions are applied as necessary:
The result returned by the call is boxed if it is a primitive, or forced to null if the return type is void.
This call is equivalent to the following code:
MethodHandle invoker = MethodHandles.spreadInvoker(this.type(), 0); Object result = invoker.invokeExact(this, arguments);
Unlike the signature polymorphic methodsinvokeExact andinvoke,invokeWithArguments can be accessed normally via the Core Reflection API and JNI. It can therefore be used as a bridge between native or reflective code and method handles.
arguments - the arguments to pass to the targetClassCastException - if an argument cannot be converted by reference castingWrongMethodTypeException - if the target's type cannot be adjusted to take the given number ofObject argumentsThrowable - anything thrown by the target method invocationMethodHandles.spreadInvoker(java.lang.invoke.MethodType, int)public Object invokeWithArguments(List<?> arguments) throwsThrowable
invoke from a call site which mentions only the typeObject, and whose arity is the length of the argument array.This method is also equivalent to the following code:
invokeWithArguments(arguments.toArray()
arguments - the arguments to pass to the targetNullPointerException - ifarguments is a null referenceClassCastException - if an argument cannot be converted by reference castingWrongMethodTypeException - if the target's type cannot be adjusted to take the given number ofObject argumentsThrowable - anything thrown by the target method invocationpublic MethodHandle asType(MethodType newType)
If the original type and new type are equal, returnsthis.
The new method handle, when invoked, will perform the following steps:
This method provides the crucial behavioral difference betweeninvokeExact and plain, inexactinvoke. The two methods perform the same steps when the caller's type descriptor exactly m atches the callee's, but when the types differ, plaininvoke also callsasType (or some internal equivalent) in order to match up the caller's and callee's types.
If the current method is a variable arity method handle argument list conversion may involve the conversion and collection of several arguments into an array, asdescribed elsewhere. In every other case, all conversions are appliedpairwise, which means that each argument or return value is converted to exactly one argument or return value (or no return value). The applied conversions are defined by consulting the the corresponding component types of the old and new method handle types.
LetT0 andT1 be corresponding new and old parameter types, or old and new return types. Specifically, for some valid indexi, letT0=newType.parameterType(i) andT1=this.type().parameterType(i). Or else, going the other way for return values, letT0=this.type().returnType() andT1=newType.returnType(). If the types are the same, the new method handle makes no change to the corresponding argument or return value (if any). Otherwise, one of the following conversions is applied if possible:
java.lang.reflect.Method.invoke.) The unboxing conversion must have a possibility of success, which means that ifT0 is not itself a wrapper class, there must exist at least one wrapper classTW which is a subtype ofT0 and whose unboxed primitive value can be widened toT1.The method handle conversion cannot be made if any one of the required pairwise conversions cannot be made.
At runtime, the conversions applied to reference arguments or return values may require additional runtime checks which can fail. An unboxing operation may fail because the original reference is null, causing aNullPointerException. An unboxing operation or a reference cast may also fail on a reference to an object of the wrong type, causing aClassCastException. Although an unboxing operation may accept several kinds of wrappers, if none are available, aClassCastException will be thrown.
newType - the expected type of the new method handlethis after performing any necessary argument conversions, and arranges for any necessary return value conversionsNullPointerException - ifnewType is a null referenceWrongMethodTypeException - if the conversion cannot be madeMethodHandles.explicitCastArguments(java.lang.invoke.MethodHandle, java.lang.invoke.MethodType)public MethodHandle asSpreader(Class<?> arrayType, int arrayLength)
arrayLength parameters of the target's type are replaced by a single array parameter of typearrayType. If the array element type differs from any of the corresponding argument types on the original target, the original target is adapted to take the array elements directly, as if by a call toasType.
When called, the adapter replaces a trailing array argument by the array's elements, each as its own argument to the target. (The order of the arguments is preserved.) They are converted pairwise by casting and/or unboxing to the types of the trailing parameters of the target. Finally the target is called. What the target eventually returns is returned unchanged by the adapter.
Before calling the target, the adapter verifies that the array contains exactly enough elements to provide a correct argument count to the target method handle. (The array may also be null when zero elements are required.)
If, when the adapter is called, the supplied array argument does not have the correct number of elements, the adapter will throw anIllegalArgumentException instead of invoking the target.
Here are some simple examples of array-spreading method handles:
MethodHandle equals = publicLookup() .findVirtual(String.class, "equals", methodType(boolean.class, Object.class));assert( (boolean) equals.invokeExact("me", (Object)"me"));assert(!(boolean) equals.invokeExact("me", (Object)"thee"));// spread both arguments from a 2-array:MethodHandle eq2 = equals.asSpreader(Object[].class, 2);assert( (boolean) eq2.invokeExact(new Object[]{ "me", "me" }));assert(!(boolean) eq2.invokeExact(new Object[]{ "me", "thee" }));// try to spread from anything but a 2-array:for (int n = 0; n <= 10; n++) { Object[] badArityArgs = (n == 2 ? null : new Object[n]); try { assert((boolean) eq2.invokeExact(badArityArgs) && false); } catch (IllegalArgumentException ex) { } // OK}// spread both arguments from a String array:MethodHandle eq2s = equals.asSpreader(String[].class, 2);assert( (boolean) eq2s.invokeExact(new String[]{ "me", "me" }));assert(!(boolean) eq2s.invokeExact(new String[]{ "me", "thee" }));// spread second arguments from a 1-array:MethodHandle eq1 = equals.asSpreader(Object[].class, 1);assert( (boolean) eq1.invokeExact("me", new Object[]{ "me" }));assert(!(boolean) eq1.invokeExact("me", new Object[]{ "thee" }));// spread no arguments from a 0-array or null:MethodHandle eq0 = equals.asSpreader(Object[].class, 0);assert( (boolean) eq0.invokeExact("me", (Object)"me", new Object[0]));assert(!(boolean) eq0.invokeExact("me", (Object)"thee", (Object[])null));// asSpreader and asCollector are approximate inverses:for (int n = 0; n <= 2; n++) { for (Class<?> a : new Class<?>[]{Object[].class, String[].class, CharSequence[].class}) { MethodHandle equals2 = equals.asSpreader(a, n).asCollector(a, n); assert( (boolean) equals2.invokeWithArguments("me", "me")); assert(!(boolean) equals2.invokeWithArguments("me", "thee")); }}MethodHandle caToString = publicLookup() .findStatic(Arrays.class, "toString", methodType(String.class, char[].class));assertEquals("[A, B, C]", (String) caToString.invokeExact("ABC".toCharArray()));MethodHandle caString3 = caToString.asCollector(char[].class, 3);assertEquals("[A, B, C]", (String) caString3.invokeExact('A', 'B', 'C'));MethodHandle caToString2 = caString3.asSpreader(char[].class, 2);assertEquals("[A, B, C]", (String) caToString2.invokeExact('A', "BC".toCharArray()));
arrayType - usuallyObject[], the type of the array argument from which to extract the spread argumentsarrayLength - the number of arguments to spread from an incoming array argumentNullPointerException - ifarrayType is a null referenceIllegalArgumentException - ifarrayType is not an array type, or if target does not have at leastarrayLength parameter types, or ifarrayLength is negative, or if the resulting method handle's type would havetoo many parametersWrongMethodTypeException - if the impliedasType call failsasCollector(java.lang.Class<?>, int)public MethodHandle asCollector(Class<?> arrayType, int arrayLength)
arrayType) is replaced byarrayLength parameters whose type is element type ofarrayType. If the array type differs from the final argument type on the original target, the original target is adapted to take the array type directly, as if by a call toasType.
When called, the adapter replaces its trailingarrayLength arguments by a single new array of typearrayType, whose elements comprise (in order) the replaced arguments. Finally the target is called. What the target eventually returns is returned unchanged by the adapter.
(The array may also be a shared constant whenarrayLength is zero.)
(Note: ThearrayType is often identical to the last parameter type of the original target. It is an explicit argument for symmetry withasSpreader, and also to allow the target to use a simpleObject as its last parameter type.)
In order to create a collecting adapter which is not restricted to a particular number of collected arguments, useasVarargsCollector instead.
Here are some examples of array-collecting method handles:
MethodHandle deepToString = publicLookup() .findStatic(Arrays.class, "deepToString", methodType(String.class, Object[].class));assertEquals("[won]", (String) deepToString.invokeExact(new Object[]{"won"}));MethodHandle ts1 = deepToString.asCollector(Object[].class, 1);assertEquals(methodType(String.class, Object.class), ts1.type());//assertEquals("[won]", (String) ts1.invokeExact( new Object[]{"won"})); //FAILassertEquals("[[won]]", (String) ts1.invokeExact((Object) new Object[]{"won"}));// arrayType can be a subtype of Object[]MethodHandle ts2 = deepToString.asCollector(String[].class, 2);assertEquals(methodType(String.class, String.class, String.class), ts2.type());assertEquals("[two, too]", (String) ts2.invokeExact("two", "too"));MethodHandle ts0 = deepToString.asCollector(Object[].class, 0);assertEquals("[]", (String) ts0.invokeExact());// collectors can be nested, Lisp-styleMethodHandle ts22 = deepToString.asCollector(Object[].class, 3).asCollector(String[].class, 2);assertEquals("[A, B, [C, D]]", ((String) ts22.invokeExact((Object)'A', (Object)"B", "C", "D")));// arrayType can be any primitive array typeMethodHandle bytesToString = publicLookup() .findStatic(Arrays.class, "toString", methodType(String.class, byte[].class)) .asCollector(byte[].class, 3);assertEquals("[1, 2, 3]", (String) bytesToString.invokeExact((byte)1, (byte)2, (byte)3));MethodHandle longsToString = publicLookup() .findStatic(Arrays.class, "toString", methodType(String.class, long[].class)) .asCollector(long[].class, 1);assertEquals("[123]", (String) longsToString.invokeExact((long)123));
arrayType - oftenObject[], the type of the array argument which will collect the argumentsarrayLength - the number of arguments to collect into a new array argumentNullPointerException - ifarrayType is a null referenceIllegalArgumentException - ifarrayType is not an array type orarrayType is not assignable to this method handle's trailing parameter type, orarrayLength is not a legal array size, or the resulting method handle's type would havetoo many parametersWrongMethodTypeException - if the impliedasType call failsasSpreader(java.lang.Class<?>, int),asVarargsCollector(java.lang.Class<?>)public MethodHandle asVarargsCollector(Class<?> arrayType)
The type and behavior of the adapter will be the same as the type and behavior of the target, except that certaininvoke andasType requests can lead to trailing positional arguments being collected into target's trailing parameter. Also, the last parameter type of the adapter will bearrayType, even if the target has a different last parameter type.
This transformation may returnthis if the method handle is already of variable arity and its trailing parameter type is identical toarrayType.
When called withinvokeExact, the adapter invokes the target with no argument changes. (Note: This behavior is different from afixed arity collector, since it accepts a whole array of indeterminate length, rather than a fixed number of arguments.)
When called with plain, inexactinvoke, if the caller type is the same as the adapter, the adapter invokes the target as withinvokeExact. (This is the normal behavior forinvoke when types match.)
Otherwise, if the caller and adapter arity are the same, and the trailing parameter type of the caller is a reference type identical to or assignable to the trailing parameter type of the adapter, the arguments and return values are converted pairwise, as if byasType on a fixed arity method handle.
Otherwise, the arities differ, or the adapter's trailing parameter type is not assignable from the corresponding caller type. In this case, the adapter replaces all trailing arguments from the original trailing argument position onward, by a new array of typearrayType, whose elements comprise (in order) the replaced arguments.
The caller type must provides as least enough arguments, and of the correct type, to satisfy the target's requirement for positional arguments before the trailing array argument. Thus, the caller must supply, at a minimum,N-1 arguments, whereN is the arity of the target. Also, there must exist conversions from the incoming arguments to the target's arguments. As with other uses of plaininvoke, if these basic requirements are not fulfilled, aWrongMethodTypeException may be thrown.
In all cases, what the target eventually returns is returned unchanged by the adapter.
In the final case, it is exactly as if the target method handle were temporarily adapted with afixed arity collector to the arity required by the caller type. (As withasCollector, if the array length is zero, a shared constant may be used instead of a new array. If the implied call toasCollector would throw anIllegalArgumentException orWrongMethodTypeException, the call to the variable arity adapter must throwWrongMethodTypeException.)
The behavior ofasType is also specialized for variable arity adapters, to maintain the invariant that plain, inexactinvoke is always equivalent to anasType call to adjust the target type, followed byinvokeExact. Therefore, a variable arity adapter responds to anasType request by building a fixed arity collector, if and only if the adapter and requested type differ either in arity or trailing argument type. The resulting fixed arity collector has its type further adjusted (if necessary) to the requested type by pairwise conversion, as if by another application ofasType.
When a method handle is obtained by executing anldc instruction of aCONSTANT_MethodHandle constant, and the target method is marked as a variable arity method (with the modifier bit0x0080), the method handle will accept multiple arities, as if the method handle constant were created by means of a call toasVarargsCollector.
In order to create a collecting adapter which collects a predetermined number of arguments, and whose type reflects this predetermined number, useasCollector instead.
No method handle transformations produce new method handles with variable arity, unless they are documented as doing so. Therefore, besidesasVarargsCollector, all methods inMethodHandle andMethodHandles will return a method handle with fixed arity, except in the cases where they are specified to return their original operand (e.g.,asType of the method handle's own type).
CallingasVarargsCollector on a method handle which is already of variable arity will produce a method handle with the same type and behavior. It may (or may not) return the original variable arity method handle.
Here is an example, of a list-making variable arity method handle:
MethodHandle deepToString = publicLookup() .findStatic(Arrays.class, "deepToString", methodType(String.class, Object[].class));MethodHandle ts1 = deepToString.asVarargsCollector(Object[].class);assertEquals("[won]", (String) ts1.invokeExact( new Object[]{"won"}));assertEquals("[won]", (String) ts1.invoke( new Object[]{"won"}));assertEquals("[won]", (String) ts1.invoke( "won" ));assertEquals("[[won]]", (String) ts1.invoke((Object) new Object[]{"won"}));// findStatic of Arrays.asList(...) produces a variable arity method handle:MethodHandle asList = publicLookup() .findStatic(Arrays.class, "asList", methodType(List.class, Object[].class));assertEquals(methodType(List.class, Object[].class), asList.type());assert(asList.isVarargsCollector());assertEquals("[]", asList.invoke().toString());assertEquals("[1]", asList.invoke(1).toString());assertEquals("[two, too]", asList.invoke("two", "too").toString());String[] argv = { "three", "thee", "tee" };assertEquals("[three, thee, tee]", asList.invoke(argv).toString());assertEquals("[three, thee, tee]", asList.invoke((Object[])argv).toString());List ls = (List) asList.invoke((Object)argv);assertEquals(1, ls.size());assertEquals("[three, thee, tee]", Arrays.toString((Object[])ls.get(0)));
Discussion: These rules are designed as a dynamically-typed variation of the Java rules for variable arity methods. In both cases, callers to a variable arity method or method handle can either pass zero or more positional arguments, or else pass pre-collected arrays of any length. Users should be aware of the special role of the final argument, and of the effect of a type match on that final argument, which determines whether or not a single trailing argument is interpreted as a whole array or a single element of an array to be collected. Note that the dynamic type of the trailing argument has no effect on this decision, only a comparison between the symbolic type descriptor of the call site and the type descriptor of the method handle.)
arrayType - oftenObject[], the type of the array argument which will collect the argumentsNullPointerException - ifarrayType is a null referenceIllegalArgumentException - ifarrayType is not an array type orarrayType is not assignable to this method handle's trailing parameter typeasCollector(java.lang.Class<?>, int),isVarargsCollector(),asFixedArity()public boolean isVarargsCollector()
ldc instruction of aCONSTANT_MethodHandle which resolves to a variable arity Java method or constructorinvoke callsasVarargsCollector(java.lang.Class<?>),asFixedArity()public MethodHandle asFixedArity()
If the current method handle is not ofvariable arity, the current method handle is returned. This is true even if the current method handle could not be a valid input toasVarargsCollector.
Otherwise, the resulting fixed-arity method handle has the same type and behavior of the current method handle, except thatisVarargsCollector will be false. The fixed-arity method handle may (or may not) be the a previous argument toasVarargsCollector.
Here is an example, of a list-making variable arity method handle:
MethodHandle asListVar = publicLookup() .findStatic(Arrays.class, "asList", methodType(List.class, Object[].class)) .asVarargsCollector(Object[].class);MethodHandle asListFix = asListVar.asFixedArity();assertEquals("[1]", asListVar.invoke(1).toString());Exception caught = null;try { asListFix.invoke((Object)1); }catch (Exception ex) { caught = ex; }assert(caught instanceof ClassCastException);assertEquals("[two, too]", asListVar.invoke("two", "too").toString());try { asListFix.invoke("two", "too"); }catch (Exception ex) { caught = ex; }assert(caught instanceof WrongMethodTypeException);Object[] argv = { "three", "thee", "tee" };assertEquals("[three, thee, tee]", asListVar.invoke(argv).toString());assertEquals("[three, thee, tee]", asListFix.invoke(argv).toString());assertEquals(1, ((List) asListVar.invoke((Object)argv)).size());assertEquals("[three, thee, tee]", asListFix.invoke((Object)argv).toString());
asVarargsCollector(java.lang.Class<?>),isVarargsCollector()public MethodHandle bindTo(Object x)
x to the first argument of a method handle, without invoking it. The new method handle adapts, as itstarget, the current method handle by binding it to the given argument. The type of the bound handle will be the same as the type of the target, except that a single leading reference parameter will be omitted. When called, the bound handle inserts the given valuex as a new leading argument to the target. The other arguments are also passed unchanged. What the target eventually returns is returned unchanged by the bound handle.
The referencex must be convertible to the first parameter type of the target.
(Note: Because method handles are immutable, the target method handle retains its original type and behavior.)
x - the value to bind to the first argument of the targetIllegalArgumentException - if the target does not have a leading parameter type that is a reference typeClassCastException - ifx cannot be converted to the leading parameter type of the targetMethodHandles.insertArguments(java.lang.invoke.MethodHandle, int, java.lang.Object...)public String toString()
"MethodHandle" and ending with the string representation of the method handle's type. In other words, this method returns a string equal to the value of:"MethodHandle" + type().toString()
(Note: Future releases of this API may add further information to the string representation. Therefore, the present syntax should not be parsed by applications.)