org.jruby.cext

Class Handle

java.lang.Object

java.lang.ref.Reference<T>

java.lang.ref.WeakReference<java.lang.Object>

org.jruby.cext.Cleaner

org.jruby.cext.Handle

public final class Handle
extends Cleaner

A Handle represents an object made available to native code tied to it's runtime.

Field Summary

Fields

Modifier and Type	Field and Description
private long	address
private static long	FIXNUM_FLAG
private static long	FIXNUM_MAX
private static long	FIXNUM_MIN
private static int	FIXNUM_SHIFT
private static long	Qfalse
private static long	Qnil
private static long	Qtrue
private Ruby	runtime
private static long	SYMBOL_FLAG
private static int	SYMBOL_SHIFT

Constructor Summary

Constructors

Modifier	Constructor and Description
private	Handle(Ruby runtime, java.lang.Object obj, long address)

Method Summary

Modifier and Type	Method and Description
(package private) void	dispose()
boolean	equals(java.lang.Object obj)
long	getAddress()
int	hashCode()
(package private) static long	nativeHandle(IRubyObject obj)
(package private) static Handle	newHandle(Ruby runtime, java.lang.Object rubyObject, long nativeHandle)
java.lang.String	toString()
(package private) static Handle	valueOf(IRubyObject obj) Retrieves the Handle object associated with a RubyObject.

Methods inherited from class org.jruby.cext.Cleaner

register

Methods inherited from class java.lang.ref.Reference

clear, enqueue, get, isEnqueued

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

FIXNUM_MAX

private static final long FIXNUM_MAX

FIXNUM_MIN

private static final long FIXNUM_MIN

FIXNUM_FLAG

private static final long FIXNUM_FLAG

See Also:

Constant Field Values

FIXNUM_SHIFT

private static final int FIXNUM_SHIFT

See Also:

Constant Field Values

SYMBOL_SHIFT

private static final int SYMBOL_SHIFT

See Also:

Constant Field Values

SYMBOL_FLAG

private static final long SYMBOL_FLAG

See Also:

Constant Field Values

Qfalse

private static final long Qfalse

See Also:

Constant Field Values

Qtrue

private static final long Qtrue

See Also:

Constant Field Values

Qnil

private static final long Qnil

See Also:

Constant Field Values

runtime

private final Ruby runtime

address

private final long address

Constructor Detail

Handle

private Handle(Ruby runtime,
               java.lang.Object obj,
               long address)

Method Detail

newHandle

static Handle newHandle(Ruby runtime,
                        java.lang.Object rubyObject,
                        long nativeHandle)

getAddress

public final long getAddress()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

dispose

void dispose()

Specified by:

dispose in class Cleaner

valueOf

static Handle valueOf(IRubyObject obj)

Retrieves the Handle object associated with a RubyObject. Retrieval is either done through the GC for Handles that have already been created, or depending on the object's native class index.
Fixnum's and Symbol's native Handles are created through bit-shifting on their values, File and Float Handles are created using special JNI methods. All other objects are passed to the generic Native.newHandle(org.jruby.runtime.builtin.IRubyObject, int) method.
Once a Handle has been created, it is registered with the GC to prevent garbage-collection during native method runs.

nativeHandle

static long nativeHandle(IRubyObject obj)

Returns:

the native Handle's address associated with the given RubyObject.