org.freedesktop.gstreamer.glib

Class NativeObject.Handle

java.lang.Object

org.freedesktop.gstreamer.glib.NativeObject.Handle

Direct Known Subclasses:

Meta.Handle, RefCountedObject.Handle

Enclosing class:

NativeObject

protected abstract static class NativeObject.Handle
extends Object

A class for managing the underlying native pointer.

Constructor Summary

Constructors

Constructor and Description
Handle(org.freedesktop.gstreamer.lowlevel.GPointer ptr, boolean ownsReference) Construct a Handle for the supplied native reference.

Method Summary

Modifier and Type	Method and Description
void	disown() Disown the native reference.
void	dispose() Dispose the handle, and dispose the native reference if owned by this handle.
protected abstract void	disposeNativeHandle(org.freedesktop.gstreamer.lowlevel.GPointer ptr) Subclasses should override this method to dispose of the native reference (free, unref, etc.).
protected org.freedesktop.gstreamer.lowlevel.GPointer	getPointer() Get the native pointer, or null.
void	invalidate() Invalidate the handle.
boolean	isCacheable() Control whether a WeakReference to the NativeObject wrapping this Handle should be created and cached.
protected boolean	ownsReference() Test whether this Handle owns the underlying native reference - should dispose the native reference on dispose().

Methods inherited from class java.lang.Object

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

Constructor Detail

Handle

public Handle(org.freedesktop.gstreamer.lowlevel.GPointer ptr,
              boolean ownsReference)

Construct a Handle for the supplied native reference.

Parameters:

ptr - native reference

ownsReference - whether the Handle owns the native reference and should dispose it when itself disposed.

Method Detail

disown

public void disown()

Disown the native reference. After calling this method, ownsReference() will return false.

invalidate

public void invalidate()

Invalidate the handle. After calling this method, getPointer() will return null, ownsReference() will return false, and any NativeObject weak reference cached for this pointer will be removed. Unlike calling dispose() the native handle will not be disposed - disposeNativeHandle(org.freedesktop.gstreamer.lowlevel.GPointer) will not be called.

dispose

public void dispose()

Dispose the handle, and dispose the native reference if owned by this handle. After calling this method, getPointer() will return null, ownsReference() will return false, and any NativeObject weak reference cached for this pointer will be removed.

isCacheable

public boolean isCacheable()

Control whether a WeakReference to the NativeObject wrapping this Handle should be created and cached. This means that the same NativeObject instance will be returned for identical native pointers, and that the Handle will be disposed automatically when the NativeObject is garbage collected.

The default implementation always returns true. Subclasses may override this behaviour if required.

Returns:

true if the NativeObject should be cached and automatically disposed

disposeNativeHandle

protected abstract void disposeNativeHandle(org.freedesktop.gstreamer.lowlevel.GPointer ptr)

Subclasses should override this method to dispose of the native reference (free, unref, etc.). The pointer supplied should be used - getPointer() will return null by the time this method is called.

Parameters:

ptr - native reference

getPointer

protected org.freedesktop.gstreamer.lowlevel.GPointer getPointer()

Get the native pointer, or null. Subclasses may override to return a GPointer subclass.

Returns:

native pointer or null

ownsReference

protected boolean ownsReference()

Test whether this Handle owns the underlying native reference - should dispose the native reference on dispose().

Returns:

true if this Handle owns the reference.