Class PointerScope

java.lang.Object

org.bytedeco.javacpp.PointerScope

All Implemented Interfaces:

AutoCloseable

public class PointerScope
extends Object
implements AutoCloseable

Pointer objects attach themselves automatically on Pointer.init(long, long, long, long) to the first PointerScope found in scopeStack that they can to based on the classes found in forClasses. The user can then call deallocate(), or rely on close() to release in a timely fashion all attached Pointer objects, instead of relying on the garbage collector.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) boolean	extend	When set to true, the next call to close() does not release but resets this variable.
(package private) Class<? extends Pointer>[]	forClasses	When not empty, indicates the classes of objects that are allowed to be attached.
private static final Logger	logger
(package private) Deque<Pointer>	pointerStack	The stack keeping references to attached Pointer objects.
(package private) static final ThreadLocal<Deque<PointerScope>>	scopeStack	A thread-local stack of PointerScope objects.

Constructor Summary

Constructors

Constructor	Description
PointerScope()	Creates a new scope accepting all pointer types and pushes itself on the scopeStack.
PointerScope(Class<? extends Pointer>... forClasses)	Initializes forClasses, and pushes itself on the scopeStack.

Method Summary

Modifier and Type	Method	Description
PointerScope	attach(Pointer p)	Pushes the Pointer onto the pointerStack of this Scope and calls Pointer.retainReference().
void	close()	Pops from pointerStack all attached pointers, calls Pointer.releaseReference() on them, unless extended, in which case it only resets the extend flag instead, and finally removes itself from scopeStack.
void	deallocate()	Pops from pointerStack all attached pointers, and calls Pointer.deallocate() on them.
PointerScope	detach(Pointer p)	Removes the Pointer from the pointerStack of this Scope and calls Pointer.releaseReference().
PointerScope	extend()	Extends the life of this scope past the next call to close() by setting the extend flag.
Class<? extends Pointer>[]	forClasses()
static PointerScope	getInnerScope()	Returns scopeStack.get().peek(), the last opened scope not yet closed.
static Iterator<PointerScope>	getScopeIterator()	Returns scopeStack.get().iterator(), all scopes not yet closed.

Methods inherited from class Object

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

Field Details

logger

private static final Logger logger

scopeStack

static final ThreadLocal<Deque<PointerScope>> scopeStack

A thread-local stack of PointerScope objects. Pointer objects attach themselves automatically on Pointer.init(long, long, long, long) to the first one they can to on the stack.

pointerStack

Deque<Pointer> pointerStack

The stack keeping references to attached Pointer objects.

forClasses

Class<? extends Pointer>[] forClasses

When not empty, indicates the classes of objects that are allowed to be attached.

extend

boolean extend

When set to true, the next call to close() does not release but resets this variable.

Constructor Details

PointerScope

public PointerScope()

Creates a new scope accepting all pointer types and pushes itself on the scopeStack.

PointerScope

public PointerScope(Class<? extends Pointer>... forClasses)

Initializes forClasses, and pushes itself on the scopeStack.

Method Details

getInnerScope

public static PointerScope getInnerScope()

Returns scopeStack.get().peek(), the last opened scope not yet closed.

getScopeIterator

public static Iterator<PointerScope> getScopeIterator()

Returns scopeStack.get().iterator(), all scopes not yet closed.

forClasses

public Class<? extends Pointer>[] forClasses()

attach

public PointerScope attach(Pointer p)

Pushes the Pointer onto the pointerStack of this Scope and calls Pointer.retainReference().

Throws:

IllegalArgumentException - when it is not an instance of a class in forClasses.

detach

public PointerScope detach(Pointer p)

Removes the Pointer from the pointerStack of this Scope and calls Pointer.releaseReference().

extend

public PointerScope extend()

Extends the life of this scope past the next call to close() by setting the extend flag.

close

public void close()

Pops from pointerStack all attached pointers, calls Pointer.releaseReference() on them, unless extended, in which case it only resets the extend flag instead, and finally removes itself from scopeStack.

Specified by:

close in interface AutoCloseable

deallocate

public void deallocate()

Pops from pointerStack all attached pointers, and calls Pointer.deallocate() on them.