Encapsulates a JNI handle to an object in the HotSpot heap. Depending on which constructor is used, the handle is either local to a JNIMethodScope and thus invalid once the scope exits or a global JNI handle that is only released sometime after the HSObject dies.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	HSObject.Cleaner

Field Summary

Modifier and Type	Field and Description
private final HSObject.Cleaner	cleaner Cleaner for Global Reference.
private static final Set<HSObject.Cleaner>	CLEANERS Strong references to the `PhantomReference` objects.
private static final ReferenceQueue<HSObject>	CLEANERS_QUEUE Queue into which a `Cleaner` is enqueued when its `HSObject` referent becomes unreachable.
private final JNI.JObject	handle JNI handle to the HotSpot object.
private HSObject	next Link to next the next scope local object.

Constructor Summary

Access	Constructor and Description
public	HSObject(JNI.JNIEnv env, JNI.JObject handle) Creates an object encapsulating a `handle` whose lifetime is determined by this object.
public	HSObject(JNI.JNIEnv env, JNI.JObject handle, boolean allowGlobalDuplicates, boolean weak) Creates an object encapsulating a `handle` whose lifetime is determined by this object.
public	HSObject(JNIMethodScope scope, JNI.JObject handle) Creates an object encapsulating a `handle` whose lifetime is limited to `scope`.

Method Summary

Modifier and Type	Method and Description
private static boolean	assertionsEnabled()
private static boolean	checkingGlobalDuplicates(boolean allowGlobalDuplicates)
private static void	checkNonExistingGlobalReference(JNI.JNIEnv env, JNI.JObject handle)
public static void	cleanHandles(JNI.JNIEnv env) Processes `CLEANERS_QUEUE` to release any handles whose objects are now unreachable.
public final JNI.JObject	getHandle()
pack-priv static int	Returns: the number of objects in the list invalidate(HSObject head) Invalidates the objects in the list starting at `head` such that subsequently calling `getHandle()` on any of the objects results in an `IllegalArgumentException`.
public final void	release(JNI.JNIEnv env)
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

Field Detail

cleaner	back to summary
private final HSObject.Cleaner cleaner Cleaner for Global Reference.

CLEANERS	back to summary
private static final Set<HSObject.Cleaner> CLEANERS Strong references to the `PhantomReference` objects.

CLEANERS_QUEUE	back to summary
private static final ReferenceQueue<HSObject> CLEANERS_QUEUE Queue into which a `Cleaner` is enqueued when its `HSObject` referent becomes unreachable.

handle	back to summary
private final JNI.JObject handle JNI handle to the HotSpot object.

next	back to summary
private HSObject next Link to next the next scope local object. The head of the list is in `JNIMethodScope#locals`. The handle of a scope local object is only valid for the lifetime of a `JNIMethodScope`. A self-reference (i.e. `this.next == this`) denotes an object whose `JNIMethodScope` has closed. This field is `null` for a non-scope local object.

Constructor Detail

HSObject	back to summary
public HSObject(JNI.JNIEnv env, JNI.JObject handle) Creates an object encapsulating a `handle` whose lifetime is determined by this object. The created `HSObject` uses a JNI global reference and does not allow duplicate JNI references. Use `HSObject(JNIEnv, JObject, boolean, boolean)` to create `HSObject` using a JNI weak reference or allowing duplicate JNI references.

HSObject	back to summary
public HSObject(JNI.JNIEnv env, JNI.JObject handle, boolean allowGlobalDuplicates, boolean weak) Creates an object encapsulating a `handle` whose lifetime is determined by this object. The created `HSObject` possibly allows duplicate JNI global handles.

HSObject	back to summary
public HSObject(JNIMethodScope scope, JNI.JObject handle) Creates an object encapsulating a `handle` whose lifetime is limited to `scope`. Once `scope.close()` is called, any attempt to use the handle will result in an `IllegalArgumentException`.

Method Detail

assertionsEnabled	back to summary
private static boolean assertionsEnabled()

checkingGlobalDuplicates	back to summary
private static boolean checkingGlobalDuplicates(boolean allowGlobalDuplicates)

checkNonExistingGlobalReference	back to summary
private static void checkNonExistingGlobalReference(JNI.JNIEnv env, JNI.JObject handle)

cleanHandles	back to summary
public static void cleanHandles(JNI.JNIEnv env) Processes `CLEANERS_QUEUE` to release any handles whose objects are now unreachable.

getHandle	back to summary
public final JNI.JObject getHandle()

invalidate back to summary

invalidate	back to summary
pack-priv static int invalidate(HSObject head) Invalidates the objects in the list starting at `head` such that subsequently calling `getHandle()` on any of the objects results in an `IllegalArgumentException`. Returns:int the number of objects in the list

pack-priv static int invalidate(HSObject head)

Invalidates the objects in the list starting at head such that subsequently calling getHandle() on any of the objects results in an IllegalArgumentException.

Returns:int: the number of objects in the list

release	back to summary
public final void release(JNI.JNIEnv env)

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override

org.graalvm.jniutils back to summary

private final Class HSObject.Cleaner

Class Inheritance

extends PhantomReference<HSObject>

Field Summary

Modifier and Type	Field and Description
private final boolean	allowGlobalDuplicates
private JNI.JObject	handle
private final boolean	weak

Constructor Summary

Access	Constructor and Description
pack-priv	Cleaner(HSObject referent, JNI.JObject handle, boolean allowGlobalDuplicates, boolean weak)

Method Summary

Modifier and Type	Method and Description
pack-priv void	clean(JNI.JNIEnv env)
private void	delete(JNI.JNIEnv env)

Inherited from java.lang.ref.PhantomReference:: get

Field Detail

allowGlobalDuplicates	back to summary
private final boolean allowGlobalDuplicates

handle	back to summary
private JNI.JObject handle

weak	back to summary
private final boolean weak

Constructor Detail

Cleaner	back to summary
pack-priv Cleaner(HSObject referent, JNI.JObject handle, boolean allowGlobalDuplicates, boolean weak)

Method Detail

clean	back to summary
pack-priv void clean(JNI.JNIEnv env)

delete	back to summary
private void delete(JNI.JNIEnv env)

public Class HSObject

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class HSObject.Cleaner

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail