org.jruby.internal.runtime.methods

Class HandleMethod

java.lang.Object

org.jruby.internal.runtime.methods.DynamicMethod

org.jruby.internal.runtime.methods.HandleMethod

All Implemented Interfaces:

java.lang.Cloneable, MethodArgs2

public class HandleMethod
extends DynamicMethod
implements MethodArgs2, java.lang.Cloneable

A DynamicMethod backed by one or more java.lang.invoke.MethodHandle objects. The MethodHandles contained in this method are used by invokedynamic-based call site binding to bind more directly to the target. Previously, the handles required for binding were built at the call site by inspecting the DynamicMethod that came in. With the newer logic, handles are created at bind time, so they're already ready and so we don't need to generate our own handle classes that might only get used by the interpreter.

Author:

headius

Nested Class Summary

Nested classes/interfaces inherited from class org.jruby.internal.runtime.methods.DynamicMethod

DynamicMethod.NativeCall, DynamicMethod.Version

Field Summary

Fields inherited from class org.jruby.internal.runtime.methods.DynamicMethod

definedClass, flags, handle, implementationClass, name, protectedClass, serialNumber

Constructor Summary

Constructors

Constructor and Description

HandleMethod(RubyModule implementationClass, Visibility visibility, java.lang.String name, long encodedSignature, boolean builtin, boolean notImplemented, java.lang.String parameterDesc, int min, int max, java.util.concurrent.Callable<java.lang.invoke.MethodHandle> maker0, java.util.concurrent.Callable<java.lang.invoke.MethodHandle> maker1, java.util.concurrent.Callable<java.lang.invoke.MethodHandle> maker2, java.util.concurrent.Callable<java.lang.invoke.MethodHandle> maker3, java.util.concurrent.Callable<java.lang.invoke.MethodHandle> maker4)

Method Summary

Modifier and Type	Method and Description
IRubyObject	call(ThreadContext context, IRubyObject self, RubyModule clazz, java.lang.String name, Block block) Arity 0, with block; calls through IRubyObject[] path
IRubyObject	call(ThreadContext context, IRubyObject self, RubyModule clazz, java.lang.String name, IRubyObject[] args, Block block) The minimum 'call' method required for a dynamic method handle.
IRubyObject	call(ThreadContext context, IRubyObject self, RubyModule clazz, java.lang.String name, IRubyObject arg0, Block block) Arity 1, with block; calls through IRubyObject[] path
IRubyObject	call(ThreadContext context, IRubyObject self, RubyModule clazz, java.lang.String name, IRubyObject arg0, IRubyObject arg1, Block block) Arity 2, with block; calls through IRubyObject[] path
IRubyObject	call(ThreadContext context, IRubyObject self, RubyModule clazz, java.lang.String name, IRubyObject arg0, IRubyObject arg1, IRubyObject arg2, Block block) Arity 3, with block; calls through IRubyObject[] path
DynamicMethod	dup() Duplicate this method, returning DynamicMethod referencing the same code and with the same attributes.
Arity	getArity() Retrieve the arity of this method, used for reporting arity to Ruby code.
java.lang.invoke.MethodHandle	getHandle(int arity)
java.lang.String[]	getParameterList()
boolean	isBuiltin()
boolean	isNative() Returns true if this method is backed by native (i.e.
boolean	isNotImplemented() Whether this method is "not implemented".

Methods inherited from class org.jruby.internal.runtime.methods.DynamicMethod

calculateProtectedClass, call, call, call, call, call, getCallConfig, getDefinedClass, getHandle, getImplementationClass, getMethodData, getName, getProtectedClass, getRealMethod, getSerialNumber, getVisibility, init, init, isCallableFrom, isImplementedBy, isNull, isUndefined, setCallConfig, setDefinedClass, setHandle, setImplementationClass, setIsBuiltin, setNotImplemented, setVisibility

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HandleMethod

public HandleMethod(RubyModule implementationClass,
                    Visibility visibility,
                    java.lang.String name,
                    long encodedSignature,
                    boolean builtin,
                    boolean notImplemented,
                    java.lang.String parameterDesc,
                    int min,
                    int max,
                    java.util.concurrent.Callable<java.lang.invoke.MethodHandle> maker0,
                    java.util.concurrent.Callable<java.lang.invoke.MethodHandle> maker1,
                    java.util.concurrent.Callable<java.lang.invoke.MethodHandle> maker2,
                    java.util.concurrent.Callable<java.lang.invoke.MethodHandle> maker3,
                    java.util.concurrent.Callable<java.lang.invoke.MethodHandle> maker4)

Method Detail

getArity

public Arity getArity()

Description copied from class: DynamicMethod

Retrieve the arity of this method, used for reporting arity to Ruby code. This arity may or may not reflect the actual specific or variable arities of the referenced method.

Overrides:

getArity in class DynamicMethod

Returns:

The arity of the method, as reported to Ruby consumers.

isBuiltin

public boolean isBuiltin()

Overrides:

isBuiltin in class DynamicMethod

isNotImplemented

public boolean isNotImplemented()

Description copied from class: DynamicMethod

Whether this method is "not implemented". This is primarily to support Ruby 1.9's behavior of respond_to? yielding false if the feature in question is unsupported (but still having the method defined).

Overrides:

isNotImplemented in class DynamicMethod

isNative

public boolean isNative()

Description copied from class: DynamicMethod

Returns true if this method is backed by native (i.e. Java) code.

Overrides:

isNative in class DynamicMethod

Returns:

true If backed by Java code or JVM bytecode; false otherwise

call

public IRubyObject call(ThreadContext context,
                        IRubyObject self,
                        RubyModule clazz,
                        java.lang.String name,
                        IRubyObject[] args,
                        Block block)

Description copied from class: DynamicMethod

The minimum 'call' method required for a dynamic method handle. Subclasses must implement this method, but may implement the other signatures to provide faster, non-boxing call paths. Typically subclasses will implement this method to check variable arity calls, then performing a specific-arity invocation to the appropriate method or performing variable-arity logic in-line.

Specified by:

call in class DynamicMethod

Parameters:

context - The thread context for the currently executing thread

self - The 'self' or 'receiver' object to use for this call

clazz - The Ruby class against which this method is binding

name - The incoming name used to invoke this method

args - The argument list to this invocation

block - The block passed to this invocation

Returns:

The result of the call

call

public IRubyObject call(ThreadContext context,
                        IRubyObject self,
                        RubyModule clazz,
                        java.lang.String name,
                        Block block)

Description copied from class: DynamicMethod

Arity 0, with block; calls through IRubyObject[] path

Overrides:

call in class DynamicMethod

call

public IRubyObject call(ThreadContext context,
                        IRubyObject self,
                        RubyModule clazz,
                        java.lang.String name,
                        IRubyObject arg0,
                        Block block)

Description copied from class: DynamicMethod

Arity 1, with block; calls through IRubyObject[] path

Overrides:

call in class DynamicMethod

call

public IRubyObject call(ThreadContext context,
                        IRubyObject self,
                        RubyModule clazz,
                        java.lang.String name,
                        IRubyObject arg0,
                        IRubyObject arg1,
                        Block block)

Description copied from class: DynamicMethod

Arity 2, with block; calls through IRubyObject[] path

Overrides:

call in class DynamicMethod

call

public IRubyObject call(ThreadContext context,
                        IRubyObject self,
                        RubyModule clazz,
                        java.lang.String name,
                        IRubyObject arg0,
                        IRubyObject arg1,
                        IRubyObject arg2,
                        Block block)

Description copied from class: DynamicMethod

Arity 3, with block; calls through IRubyObject[] path

Overrides:

call in class DynamicMethod

dup

public DynamicMethod dup()

Description copied from class: DynamicMethod

Duplicate this method, returning DynamicMethod referencing the same code and with the same attributes. It is not required that this method produce a new object if the semantics of the DynamicMethod subtype do not require such.

Specified by:

dup in class DynamicMethod

Returns:

An identical DynamicMethod object to the target.

getParameterList

public java.lang.String[] getParameterList()

Specified by:

getParameterList in interface MethodArgs2

getHandle

public java.lang.invoke.MethodHandle getHandle(int arity)