VgReferenced Class Reference

Inheritance diagram for VgReferenced:

Public Member Functions
synchronized void	release ()
	VgReferenced ()
	VgReferenced (VgReferenced pThis)
void	ref ()
int	unref ()
int	getNbReferences ()

Detailed Description

The VgReferenced class owns the number of references of an object.

It is in charge of deleting the object when there is not more references. To learn more about its usage look at the VgRefPtr documentation.

Constructor & Destructor Documentation

VgReferenced.VgReferenced

(

)

Constructor.

VgReferenced.VgReferenced

(

VgReferenced

pThis

)

Copy constructor.

Parameters

pThis

Member Function Documentation

int VgReferenced.getNbReferences

(

)

Retrieves the number of references to this object.

void VgReferenced.ref

(

)

This method is used to add a reference to this object. Only VgRefPtr should call this method unless the caller exactly know what he is doing.

synchronized void VgReferenced.release

(

)

This method synchronously releases the reference held on the native object by the java layer. It usefull when trying to avoid issues with garbage collection. The java object should not be used afterwards.

References VgReferencedRefPtr.set().

int VgReferenced.unref

(

)

This method is used to remove a reference to this object. When the object has no more references VgRefPtr will delete it. Only VgRefPtr should call this method unless the caller exactly know what he is doing.

Returns

the updated number of references left

---

The documentation for this class was generated from the following file:

• VgReferenced.java