org.bytedeco.javacpp

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. The user can then call deallocate(), or rely on close(), to deallocate in a timely fashion all attached Pointer objects, instead of relying on the garbage collector.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) boolean	deallocateOnClose When true, deallocate() gets called on close().
private static Logger	logger
(package private) Deque<Pointer>	pointerStack The stack keeping references to attached Pointer objects.
(package private) static ThreadLocal<Deque<PointerScope>>	scopeStack A thread-local stack of PointerScope objects.

Constructor Summary

Constructors

Constructor and Description
PointerScope() Calls this(true).
PointerScope(boolean deallocateOnClose) Initializes deallocateOnClose and pushes itself on the scopeStack.

Method Summary

Modifier and Type	Method and Description
PointerScope	attach(Pointer p) Pushes the Pointer onto the pointerStack of this Scope.
void	close() Calls deallocate() when deallocateOnClose is true, and removes itself from scopeStack.
void	deallocate() Calls Pointer.deallocate() on all attached pointers, as they are popped off the pointerStack.
boolean	deallocateOnClose() Returns deallocateOnClose.
PointerScope	deallocateOnClose(boolean deallocateOnClose) Sets deallocateOnClose and returns this Scope.
PointerScope	detach(Pointer p) Removes the Pointer from the pointerStack of this Scope.
static PointerScope	getInnerScope() Returns scopeStack.get().peek(), the last opened scope not yet closed.

Methods inherited from class java.lang.Object

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

Field Detail

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 on the stack.

pointerStack

Deque<Pointer> pointerStack

The stack keeping references to attached Pointer objects.

deallocateOnClose

boolean deallocateOnClose

When true, deallocate() gets called on close().

Constructor Detail

PointerScope

public PointerScope()

Calls this(true).

PointerScope

public PointerScope(boolean deallocateOnClose)

Initializes deallocateOnClose and pushes itself on the scopeStack.

Method Detail

getInnerScope

public static PointerScope getInnerScope()

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

deallocateOnClose

public PointerScope deallocateOnClose(boolean deallocateOnClose)

Sets deallocateOnClose and returns this Scope.

deallocateOnClose

public boolean deallocateOnClose()

Returns deallocateOnClose.

attach

public PointerScope attach(Pointer p)

Pushes the Pointer onto the pointerStack of this Scope.

detach

public PointerScope detach(Pointer p)

Removes the Pointer from the pointerStack of this Scope.

close

public void close()

Calls deallocate() when deallocateOnClose is true, and removes itself from scopeStack.

Specified by:

close in interface AutoCloseable

deallocate

public void deallocate()

Calls Pointer.deallocate() on all attached pointers, as they are popped off the pointerStack.