IDecRefQueue (Java Bindings for Z3)

java.lang.Object
- com.microsoft.z3.IDecRefQueue<T>

Type Parameters:

T - Type of object stored in queue.

Direct Known Subclasses:

ConstructorDecRefQueue, ConstructorListDecRefQueue
```
public abstract class IDecRefQueue<T extends Z3Object>
extends Object
```
A queue to handle management of native memory.
Mechanics: once an object is created, a metadata is stored for it in referenceMap, and a PhantomReference is created with a reference to referenceQueue. Once the object becomes strongly unreachable, the phantom reference gets added by JVM to the referenceQueue. After each object creation, we iterate through the available objects in referenceQueue and decrement references for them.

Constructor Summary

Constructors
Modifier Constructor Description

protected IDecRefQueue()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`clear(Context ctx)`	Clean all references currently in `referenceQueue`.
`protected abstract void`	`decRef(Context ctx, long obj)`	An implementation of this method should decrement the reference on a given native object.
`void`	`forceClear(Context ctx)`	Clean all references stored in `referenceMap`, regardless of whether they are in `referenceMap` or not.
`void`	`storeReference(Context ctx, T obj)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IDecRefQueue
```
protected IDecRefQueue()
```
- Method Detail
  - decRef
```
protected abstract void decRef(Context ctx,
                               long obj)
```
    An implementation of this method should decrement the reference on a given native object. This function should always be called on the ctx thread.
    
    Parameters:
    
    ctx - Z3 context.
    
    obj - Pointer to a Z3 object.
  - storeReference
```
public void storeReference(Context ctx,
                           T obj)
```
  - clear
```
protected void clear(Context ctx)
```
    Clean all references currently in referenceQueue.
  - forceClear
```
public void forceClear(Context ctx)
```
    Clean all references stored in referenceMap, regardless of whether they are in referenceMap or not.