Package org.jruby.internal.runtime.methods

Class JavaMethod

java.lang.Object

org.jruby.internal.runtime.methods.DynamicMethod

org.jruby.internal.runtime.methods.JavaMethod

All Implemented Interfaces:

Cloneable, MethodArgs2, NativeCallMethod

Direct Known Subclasses:

JavaMethod.JavaMethodNBlock, RubyToJavaInvoker

public abstract class JavaMethod
extends DynamicMethod
implements Cloneable, MethodArgs2, NativeCallMethod

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JavaMethod.JavaMethodN
static class	JavaMethod.JavaMethodNBlock
static class	JavaMethod.JavaMethodOne
static class	JavaMethod.JavaMethodOneBlock
static class	JavaMethod.JavaMethodOneOrN
static class	JavaMethod.JavaMethodOneOrNBlock
static class	JavaMethod.JavaMethodOneOrTwo
static class	JavaMethod.JavaMethodOneOrTwoBlock
static class	JavaMethod.JavaMethodOneOrTwoOrN
static class	JavaMethod.JavaMethodOneOrTwoOrNBlock
static class	JavaMethod.JavaMethodOneOrTwoOrThree
static class	JavaMethod.JavaMethodOneOrTwoOrThreeBlock
static class	JavaMethod.JavaMethodOneOrTwoOrThreeOrN
static class	JavaMethod.JavaMethodOneOrTwoOrThreeOrNBlock
static class	JavaMethod.JavaMethodThree
static class	JavaMethod.JavaMethodThreeBlock
static class	JavaMethod.JavaMethodThreeOrN
static class	JavaMethod.JavaMethodThreeOrNBlock
static class	JavaMethod.JavaMethodTwo
static class	JavaMethod.JavaMethodTwoBlock
static class	JavaMethod.JavaMethodTwoOrN
static class	JavaMethod.JavaMethodTwoOrNBlock
static class	JavaMethod.JavaMethodTwoOrThree
static class	JavaMethod.JavaMethodTwoOrThreeBlock
static class	JavaMethod.JavaMethodTwoOrThreeOrN
static class	JavaMethod.JavaMethodTwoOrThreeOrNBlock
static class	JavaMethod.JavaMethodZero
static class	JavaMethod.JavaMethodZeroBlock
static class	JavaMethod.JavaMethodZeroOrN
static class	JavaMethod.JavaMethodZeroOrNBlock
static class	JavaMethod.JavaMethodZeroOrOne
static class	JavaMethod.JavaMethodZeroOrOneBlock
static class	JavaMethod.JavaMethodZeroOrOneOrN
static class	JavaMethod.JavaMethodZeroOrOneOrNBlock
static class	JavaMethod.JavaMethodZeroOrOneOrTwo
static class	JavaMethod.JavaMethodZeroOrOneOrTwoBlock
static class	JavaMethod.JavaMethodZeroOrOneOrTwoOrN
static class	JavaMethod.JavaMethodZeroOrOneOrTwoOrNBlock
static class	JavaMethod.JavaMethodZeroOrOneOrTwoOrThree
static class	JavaMethod.JavaMethodZeroOrOneOrTwoOrThreeBlock
static class	JavaMethod.JavaMethodZeroOrOneOrTwoOrThreeOrN
static class	JavaMethod.JavaMethodZeroOrOneOrTwoOrThreeOrNBlock

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

DynamicMethod.NativeCall, DynamicMethod.Version

Field Summary

Fields

Modifier and Type	Field	Description
static final Class[][]	BLOCK_METHODS
static final Class[][]	BLOCK_REST_METHODS
static final Class[][]	METHODS
static final ThreadLocal<String>	NAME_PASSER	Deprecated.
protected DynamicMethod.NativeCall	nativeCall	Single-arity native call
protected static final String[]	REST
static final Class[][]	REST_METHODS
protected Signature	signature
protected StaticScope	staticScope

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

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

Constructor Summary

Constructors

Constructor	Description
JavaMethod(RubyModule implementationClass, Visibility visibility)	Deprecated.
JavaMethod(RubyModule implementationClass, Visibility visibility, String name)
JavaMethod(RubyModule implementationClass, Visibility visibility, CallConfiguration callConfig)	Deprecated.
JavaMethod(RubyModule implementationClass, Visibility visibility, CallConfiguration callConfig, String name)	Deprecated.

Method Summary

Modifier and Type	Method	Description
protected final void	callTrace(ThreadContext context, boolean enabled, String name)
protected final void	callTraceCompiled(ThreadContext context, boolean enabled, String name, String file, int line)
protected static void	checkArgumentCount(JavaMethod method, ThreadContext context, String name, IRubyObject[] args, int num)
DynamicMethod	dup()	Duplicate this method, returning DynamicMethod referencing the same code and with the same attributes.
Arity	getArity()	Deprecated.
CallConfiguration	getCallerRequirement()	Deprecated.
String	getJavaName()
DynamicMethod.NativeCall	getNativeCall()	Get the NativeCall for the method, if available.
String[]	getParameterList()
Signature	getSignature()	Retrieve the signature of this method.
StaticScope	getStaticScope()
boolean	isNative()	Returns true if this method is backed by native (i.e.
boolean	isSingleton()
protected static final void	postBacktraceAndScope(ThreadContext context)
protected static final void	postBacktraceDummyScope(ThreadContext context)
protected static final void	postBacktraceOnly(ThreadContext context)
protected static final void	postFrameAndScope(ThreadContext context)
protected static final void	postFrameOnly(ThreadContext context)
protected static final void	postNoFrameDummyScope(ThreadContext context)
protected static final void	postNoop(ThreadContext context)
protected static final void	postScopeOnly(ThreadContext context)
protected final void	preBacktraceAndScope(ThreadContext context, String name)
protected final void	preBacktraceDummyScope(ThreadContext context, String name)
protected final void	preBacktraceOnly(ThreadContext context, String name)
protected final void	preFrameAndDummyScope(ThreadContext context, IRubyObject self, String name, Block block)	Deprecated.
protected final void	preFrameAndDummyScope(ThreadContext context, IRubyObject self, RubyModule frameClass, String name, Block block)
protected final void	preFrameAndScope(ThreadContext context, IRubyObject self, String name, Block block)	Deprecated.
protected final void	preFrameAndScope(ThreadContext context, IRubyObject self, RubyModule frameClass, String name, Block block)
protected final void	preFrameOnly(ThreadContext context, IRubyObject self, String name, Block block)	Deprecated.
protected final void	preFrameOnly(ThreadContext context, IRubyObject self, RubyModule frameClass, String name, Block block)
protected final void	preNoFrameDummyScope(ThreadContext context)
protected final void	preNoop()
protected final void	preScopeOnly(ThreadContext context)
protected static IRubyObject	raiseArgumentError(JavaMethod method, ThreadContext context, String name, int given, int min, int max)
protected final void	returnTrace(ThreadContext context, boolean enabled, String name)
protected final void	returnTraceCompiled(ThreadContext context, boolean enabled, String name)
void	setArity(Arity arity)	Deprecated.
void	setCallerRequirement(CallConfiguration callerRequirement)	Deprecated.
void	setJavaName(String javaName)
void	setNativeCall(Class nativeTarget, String nativeName, Class nativeReturn, Class[] nativeSignature, boolean statik)	Set the single-arity NativeCall for this method.
void	setNativeCall(Class nativeTarget, String nativeName, Class nativeReturn, Class[] nativeSignature, boolean statik, boolean java)	Set the single-arity NativeCall for this method.
void	setParameterDesc(String parameterDesc)
void	setParameterList(String[] parameterList)
void	setSignature(Signature signature)
void	setSingleton(boolean isSingleton)

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

adjustAliasCount, calculateProtectedClass, call, call, call, call, call, call, call, call, call, call, callRespondTo, getAliasCount, getCallConfig, getDefinedClass, getHandle, getImplementationClass, getInstanceVariableNames, getMethodData, getName, getProtectedClass, getRealMethod, getSerialNumber, getVisibility, init, init, isBuiltin, isCallableFrom, isImplementedBy, isNotImplemented, isNull, isRefined, isUndefined, setCallConfig, setDefinedClass, setHandle, setImplementationClass, setIsBuiltin, setNotImplemented, setRuby2Keywords, setVisibility

Methods inherited from class java.lang.Object

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

Field Details

signature

protected Signature signature

staticScope

protected StaticScope staticScope

nativeCall

protected DynamicMethod.NativeCall nativeCall

Single-arity native call

REST

protected static final String[] REST

METHODS

public static final Class[][] METHODS

REST_METHODS

public static final Class[][] REST_METHODS

BLOCK_METHODS

public static final Class[][] BLOCK_METHODS

BLOCK_REST_METHODS

public static final Class[][] BLOCK_REST_METHODS

NAME_PASSER

@Deprecated
public static final ThreadLocal<String> NAME_PASSER

Deprecated.

Used for old-style nameless constructor to pass name in out-of-band.

Constructor Details

JavaMethod

public JavaMethod(RubyModule implementationClass,
 Visibility visibility,
 String name)

JavaMethod

@Deprecated
public JavaMethod(RubyModule implementationClass,
 Visibility visibility,
 CallConfiguration callConfig)

Deprecated.

JavaMethod

@Deprecated
public JavaMethod(RubyModule implementationClass,
 Visibility visibility,
 CallConfiguration callConfig,
 String name)

Deprecated.

JavaMethod

@Deprecated
public JavaMethod(RubyModule implementationClass,
 Visibility visibility)

Deprecated.

Method Details

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.

preFrameAndScope

protected final void preFrameAndScope(ThreadContext context,
 IRubyObject self,
 RubyModule frameClass,
 String name,
 Block block)

preFrameAndDummyScope

protected final void preFrameAndDummyScope(ThreadContext context,
 IRubyObject self,
 RubyModule frameClass,
 String name,
 Block block)

preFrameOnly

protected final void preFrameOnly(ThreadContext context,
 IRubyObject self,
 RubyModule frameClass,
 String name,
 Block block)

preFrameAndScope

@Deprecated
protected final void preFrameAndScope(ThreadContext context,
 IRubyObject self,
 String name,
 Block block)

Deprecated.

preFrameAndDummyScope

@Deprecated
protected final void preFrameAndDummyScope(ThreadContext context,
 IRubyObject self,
 String name,
 Block block)

Deprecated.

preFrameOnly

@Deprecated
protected final void preFrameOnly(ThreadContext context,
 IRubyObject self,
 String name,
 Block block)

Deprecated.

preScopeOnly

protected final void preScopeOnly(ThreadContext context)

preNoFrameDummyScope

protected final void preNoFrameDummyScope(ThreadContext context)

preBacktraceOnly

protected final void preBacktraceOnly(ThreadContext context,
 String name)

preBacktraceDummyScope

protected final void preBacktraceDummyScope(ThreadContext context,
 String name)

preBacktraceAndScope

protected final void preBacktraceAndScope(ThreadContext context,
 String name)

preNoop

protected final void preNoop()

postFrameAndScope

protected static final void postFrameAndScope(ThreadContext context)

postFrameOnly

protected static final void postFrameOnly(ThreadContext context)

postScopeOnly

protected static final void postScopeOnly(ThreadContext context)

postNoFrameDummyScope

protected static final void postNoFrameDummyScope(ThreadContext context)

postBacktraceOnly

protected static final void postBacktraceOnly(ThreadContext context)

postBacktraceDummyScope

protected static final void postBacktraceDummyScope(ThreadContext context)

postBacktraceAndScope

protected static final void postBacktraceAndScope(ThreadContext context)

postNoop

protected static final void postNoop(ThreadContext context)

callTrace

protected final void callTrace(ThreadContext context,
 boolean enabled,
 String name)

returnTrace

protected final void returnTrace(ThreadContext context,
 boolean enabled,
 String name)

callTraceCompiled

protected final void callTraceCompiled(ThreadContext context,
 boolean enabled,
 String name,
 String file,
 int line)

returnTraceCompiled

protected final void returnTraceCompiled(ThreadContext context,
 boolean enabled,
 String name)

setArity

@Deprecated
public void setArity(Arity arity)

Deprecated.

setSignature

public void setSignature(Signature signature)

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

setJavaName

public void setJavaName(String javaName)

getJavaName

public String getJavaName()

setSingleton

public void setSingleton(boolean isSingleton)

isSingleton

public boolean isSingleton()

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

getStaticScope

public StaticScope getStaticScope()

setParameterDesc

public void setParameterDesc(String parameterDesc)

setParameterList

public void setParameterList(String[] parameterList)

getParameterList

public String[] getParameterList()

Specified by:

getParameterList in interface MethodArgs2

setNativeCall

public void setNativeCall(Class nativeTarget,
 String nativeName,
 Class nativeReturn,
 Class[] nativeSignature,
 boolean statik,
 boolean java)

Description copied from interface: NativeCallMethod

Set the single-arity NativeCall for this method. All signatures for the non-single-arity getNativeCall will also be set to this value.

Specified by:

setNativeCall in interface NativeCallMethod

Parameters:

nativeTarget - native method target

nativeName - native method name

nativeReturn - native method return

nativeSignature - native method arguments

statik - static?

java - plain Java method?

See Also:

• NativeCallMethod.setNativeCall(Class, String, Class, Class[], boolean, boolean)

setNativeCall

public void setNativeCall(Class nativeTarget,
 String nativeName,
 Class nativeReturn,
 Class[] nativeSignature,
 boolean statik)

Description copied from interface: NativeCallMethod

Set the single-arity NativeCall for this method. All signatures for the non-single-arity getNativeCall will also be set to this value.

Specified by:

setNativeCall in interface NativeCallMethod

Parameters:

nativeTarget - native method target

nativeName - native method name

nativeReturn - native method return

nativeSignature - native method arguments

statik - static?

See Also:

• NativeCallMethod.setNativeCall(Class, String, Class, Class[], boolean)

getNativeCall

public DynamicMethod.NativeCall getNativeCall()

Description copied from interface: NativeCallMethod

Get the NativeCall for the method, if available.

Specified by:

getNativeCall in interface NativeCallMethod

Returns:

a NativeCall if the method has a native representation.

See Also:

• NativeCallMethod.getNativeCall()

raiseArgumentError

protected static IRubyObject raiseArgumentError(JavaMethod method,
 ThreadContext context,
 String name,
 int given,
 int min,
 int max)

checkArgumentCount

protected static void checkArgumentCount(JavaMethod method,
 ThreadContext context,
 String name,
 IRubyObject[] args,
 int num)

getCallerRequirement

@Deprecated
public CallConfiguration getCallerRequirement()

Deprecated.

setCallerRequirement

@Deprecated
public void setCallerRequirement(CallConfiguration callerRequirement)

Deprecated.