org.jruby.internal.runtime.methods

Class DelegatingDynamicMethod

java.lang.Object

org.jruby.internal.runtime.methods.DynamicMethod

org.jruby.internal.runtime.methods.DelegatingDynamicMethod

Direct Known Subclasses:

ProfilingDynamicMethod, SynchronizedDynamicMethod

public abstract class DelegatingDynamicMethod
extends DynamicMethod

Nested Class Summary

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

DynamicMethod.NativeCall, DynamicMethod.Version

Field Summary

Fields

Modifier and Type	Field and Description
protected DynamicMethod	delegate

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

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

Constructor Summary

Constructors

Constructor and Description
DelegatingDynamicMethod(DynamicMethod delegate)

Method Summary

Modifier and Type	Method and Description
IRubyObject	call(ThreadContext context, IRubyObject self, RubyModule klazz, java.lang.String name) Arity 0, no block
IRubyObject	call(ThreadContext context, IRubyObject self, RubyModule klazz, java.lang.String name, Block block) Arity 0, with block; calls through IRubyObject[] path
IRubyObject	call(ThreadContext context, IRubyObject self, RubyModule klazz, java.lang.String name, IRubyObject arg) Arity 1, no block
IRubyObject	call(ThreadContext context, IRubyObject self, RubyModule klazz, java.lang.String name, IRubyObject[] args) A default implementation of n-arity, non-block 'call' method, which simply calls the n-arity, block-receiving version with the arg list and Block.NULL_BLOCK.
IRubyObject	call(ThreadContext context, IRubyObject self, RubyModule klazz, 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 klazz, java.lang.String name, IRubyObject arg1, Block block) Arity 1, with block; calls through IRubyObject[] path
IRubyObject	call(ThreadContext context, IRubyObject self, RubyModule klazz, java.lang.String name, IRubyObject arg1, IRubyObject arg2) Arity 2, no block
IRubyObject	call(ThreadContext context, IRubyObject self, RubyModule klazz, java.lang.String name, IRubyObject arg1, IRubyObject arg2, Block block) Arity 2, with block; calls through IRubyObject[] path
IRubyObject	call(ThreadContext context, IRubyObject self, RubyModule klazz, java.lang.String name, IRubyObject arg1, IRubyObject arg2, IRubyObject arg3) Arity 3, no block
IRubyObject	call(ThreadContext context, IRubyObject self, RubyModule klazz, java.lang.String name, IRubyObject arg1, IRubyObject arg2, IRubyObject arg3, Block block) Arity 3, with block; calls through IRubyObject[] path
abstract DynamicMethod	dup() Duplicate this method, returning DynamicMethod referencing the same code and with the same attributes.
boolean	equals(java.lang.Object other)
Arity	getArity() Deprecated.
DynamicMethod	getDelegate()
java.lang.Object	getHandle() Get the "handle" associated with this DynamicMethod.
RubyModule	getImplementationClass() Retrieve the class or module on which this method is implemented, used for 'super' logic among others.
java.util.Collection<java.lang.String>	getInstanceVariableNames()
MethodData	getMethodData() Additional metadata about this method.
java.lang.String	getName() Get the base name this method was defined as.
protected RubyModule	getProtectedClass() Retrieve the pre-calculated "protected class" used for access checks.
DynamicMethod	getRealMethod() Get the "real" method contained within this method.
long	getSerialNumber() Get the global serial number for this method object
Signature	getSignature() Retrieve the signature of this method.
Visibility	getVisibility() Get the visibility of this method.
boolean	isBuiltin() Whether this method is a builtin method, i.e.
boolean	isCallableFrom(IRubyObject caller, CallType callType) Determine whether this method is callable from the given object using the given call type.
boolean	isImplementedBy(RubyModule other)
boolean	isNative() Returns true if this method is backed by native (i.e.
boolean	isNotImplemented() Whether this method is "not implemented".
boolean	isRefined()
void	setHandle(java.lang.Object handle) Set the "handle" associated with this DynamicMethod.
void	setImplementationClass(RubyModule implClass) Set the class on which this method is implemented, used for 'super' logic, among others.
void	setIsBuiltin(boolean isBuiltin) Force this method to be treated as a core built-in method if true, or as a normal non-core method otherwise.
void	setNotImplemented(boolean setNotImplemented) Set whether this method is "not implemented".
void	setVisibility(Visibility visibility) Set the visibility of this method.

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

calculateProtectedClass, callRespondTo, getCallConfig, getDefinedClass, init, init, isNull, isUndefined, setCallConfig, setDefinedClass

Methods inherited from class java.lang.Object

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

Field Detail

delegate

protected final DynamicMethod delegate

Constructor Detail

DelegatingDynamicMethod

public DelegatingDynamicMethod(DynamicMethod delegate)

Method Detail

getDelegate

public DynamicMethod getDelegate()

call

public IRubyObject call(ThreadContext context,
                        IRubyObject self,
                        RubyModule klazz,
                        java.lang.String name)

Description copied from class: DynamicMethod

Arity 0, no block

Overrides:

call in class DynamicMethod

call

public IRubyObject call(ThreadContext context,
                        IRubyObject self,
                        RubyModule klazz,
                        java.lang.String name,
                        IRubyObject arg)

Description copied from class: DynamicMethod

Arity 1, no block

Overrides:

call in class DynamicMethod

call

public IRubyObject call(ThreadContext context,
                        IRubyObject self,
                        RubyModule klazz,
                        java.lang.String name,
                        IRubyObject arg1,
                        IRubyObject arg2)

Description copied from class: DynamicMethod

Arity 2, no block

Overrides:

call in class DynamicMethod

call

public IRubyObject call(ThreadContext context,
                        IRubyObject self,
                        RubyModule klazz,
                        java.lang.String name,
                        IRubyObject arg1,
                        IRubyObject arg2,
                        IRubyObject arg3)

Description copied from class: DynamicMethod

Arity 3, no block

Overrides:

call in class DynamicMethod

call

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

Description copied from class: DynamicMethod

A default implementation of n-arity, non-block 'call' method, which simply calls the n-arity, block-receiving version with the arg list and Block.NULL_BLOCK.

Overrides:

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

klazz - The Ruby class against which this method is binding

name - The incoming name used to invoke this method

args - The first argument to this invocation

Returns:

The result of the call

call

public IRubyObject call(ThreadContext context,
                        IRubyObject self,
                        RubyModule klazz,
                        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 klazz,
                        java.lang.String name,
                        IRubyObject arg1,
                        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 klazz,
                        java.lang.String name,
                        IRubyObject arg1,
                        IRubyObject arg2,
                        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 klazz,
                        java.lang.String name,
                        IRubyObject arg1,
                        IRubyObject arg2,
                        IRubyObject arg3,
                        Block block)

Description copied from class: DynamicMethod

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

Overrides:

call in class DynamicMethod

call

public IRubyObject call(ThreadContext context,
                        IRubyObject self,
                        RubyModule klazz,
                        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

klazz - 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

setVisibility

public void setVisibility(Visibility visibility)

Description copied from class: DynamicMethod

Set the visibility of this method.

Overrides:

setVisibility in class DynamicMethod

Parameters:

visibility - The visibility of this method

setIsBuiltin

public void setIsBuiltin(boolean isBuiltin)

Description copied from class: DynamicMethod

Force this method to be treated as a core built-in method if true, or as a normal non-core method otherwise.

Overrides:

setIsBuiltin in class DynamicMethod

Parameters:

isBuiltin - true if this is a core built-in method, false otherwise

setImplementationClass

public void setImplementationClass(RubyModule implClass)

Description copied from class: DynamicMethod

Set the class on which this method is implemented, used for 'super' logic, among others.

Overrides:

setImplementationClass in class DynamicMethod

Parameters:

implClass - The class on which this method is implemented

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

isCallableFrom

public boolean isCallableFrom(IRubyObject caller,
                              CallType callType)

Description copied from class: DynamicMethod

Determine whether this method is callable from the given object using the given call type.

Overrides:

isCallableFrom in class DynamicMethod

Parameters:

caller - The calling object

callType - The type of call

Returns:

true if the call would not violate visibility; false otherwise

isBuiltin

public boolean isBuiltin()

Description copied from class: DynamicMethod

Whether this method is a builtin method, i.e. a method built-in to JRuby and loaded during its core boot process.

Overrides:

isBuiltin in class DynamicMethod

Returns:

true if this is a core built-in method, false otherwise

getVisibility

public Visibility getVisibility()

Description copied from class: DynamicMethod

Get the visibility of this method.

Overrides:

getVisibility in class DynamicMethod

Returns:

The visibility of this method

getSerialNumber

public long getSerialNumber()

Description copied from class: DynamicMethod

Get the global serial number for this method object

Overrides:

getSerialNumber in class DynamicMethod

Returns:

This method object's serial number

getRealMethod

public DynamicMethod getRealMethod()

Description copied from class: DynamicMethod

Get the "real" method contained within this method. This simply returns self except in cases where a method is wrapped to give it a new name or new implementation class (AliasMethod, PartialDelegatingMethod, ...).

Overrides:

getRealMethod in class DynamicMethod

Returns:

The "real" method associated with this one

getProtectedClass

protected RubyModule getProtectedClass()

Description copied from class: DynamicMethod

Retrieve the pre-calculated "protected class" used for access checks.

Overrides:

getProtectedClass in class DynamicMethod

Returns:

The "protected class" for access checks.

getImplementationClass

public RubyModule getImplementationClass()

Description copied from class: DynamicMethod

Retrieve the class or module on which this method is implemented, used for 'super' logic among others.

Overrides:

getImplementationClass in class DynamicMethod

Returns:

The class on which this method is implemented

isImplementedBy

public boolean isImplementedBy(RubyModule other)

Overrides:

isImplementedBy in class DynamicMethod

getArity

@Deprecated
public Arity getArity()

Deprecated.

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.

getSignature

public Signature getSignature()

Description copied from class: DynamicMethod

Retrieve the signature of this method.

Overrides:

getSignature in class DynamicMethod

Returns:

the signature

getName

public java.lang.String getName()

Description copied from class: DynamicMethod

Get the base name this method was defined as.

Overrides:

getName in class DynamicMethod

Returns:

the base name for the method

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

setNotImplemented

public void setNotImplemented(boolean setNotImplemented)

Description copied from class: DynamicMethod

Set whether this method is "not implemented".

Overrides:

setNotImplemented in class DynamicMethod

getMethodData

public MethodData getMethodData()

Description copied from class: DynamicMethod

Additional metadata about this method.

Overrides:

getMethodData in class DynamicMethod

getInstanceVariableNames

public java.util.Collection<java.lang.String> getInstanceVariableNames()

Overrides:

getInstanceVariableNames in class DynamicMethod

setHandle

public void setHandle(java.lang.Object handle)

Description copied from class: DynamicMethod

Set the "handle" associated with this DynamicMethod.

Overrides:

setHandle in class DynamicMethod

Parameters:

handle - the handle

getHandle

public java.lang.Object getHandle()

Description copied from class: DynamicMethod

Get the "handle" associated with this DynamicMethod.

Overrides:

getHandle in class DynamicMethod

Returns:

the handle

isRefined

public boolean isRefined()

Overrides:

isRefined in class DynamicMethod

dup

public abstract 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.

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object