X-Git-Url: https://gerrit.simantics.org/r/gitweb?a=blobdiff_plain;f=vtk%2Fsrc%2Fvtk%2FvtkJavaMemoryManager.java;h=05ea8913f05d8f9a4d256856b28fee03281db472;hb=refs%2Fchanges%2F26%2F4126%2F1;hp=7b4c4651735b13890d75df78479d48151869f980;hpb=471c46e9a685e20de958d77166461aebc7a7b6ee;p=simantics%2F3d.git diff --git a/vtk/src/vtk/vtkJavaMemoryManager.java b/vtk/src/vtk/vtkJavaMemoryManager.java index 7b4c4651..05ea8913 100644 --- a/vtk/src/vtk/vtkJavaMemoryManager.java +++ b/vtk/src/vtk/vtkJavaMemoryManager.java @@ -14,74 +14,74 @@ package vtk; * @author sebastien jourdain - sebastien.jourdain@kitware.com */ public interface vtkJavaMemoryManager { - /** - * Create or return an existing instance of the vtkObject that corresponds - * to the pointer id vtkId. - * - * @param vtkId - * is used to uniquely identify a vtkObject inside the C++ layer. - * - * @return a java object that map its underlying C++ instance. - */ - vtkObjectBase getJavaObject(Long vtkId); + /** + * Create or return an existing instance of the vtkObject that corresponds + * to the pointer id vtkId. + * + * @param vtkId + * is used to uniquely identify a vtkObject inside the C++ layer. + * + * @return a java object that map its underlying C++ instance. + */ + vtkObjectBase getJavaObject(Long vtkId); - /** - * Store the Java instance of a vtkObject inside a weak pointer map. - * - * @param id - * is used to uniquely identify a vtkObject inside the C++ layer. - * @param obj - * is the Java instance that is stored inside a WeakPointer of - * the map. - */ - void registerJavaObject(Long id, vtkObjectBase obj); + /** + * Store the Java instance of a vtkObject inside a weak pointer map. + * + * @param id + * is used to uniquely identify a vtkObject inside the C++ layer. + * @param obj + * is the Java instance that is stored inside a WeakPointer of + * the map. + */ + void registerJavaObject(Long id, vtkObjectBase obj); - /** - * If found the Java object is removed from the map and we decrease the - * reference count of the underneath C++ instance. - * - * @param id - */ - void unRegisterJavaObject(Long id); + /** + * If found the Java object is removed from the map and we decrease the + * reference count of the underneath C++ instance. + * + * @param id + */ + void unRegisterJavaObject(Long id); - /** - * Execute the garbage collection in the Java + VTK context to release Java - * instance that are not used anymore which keep holding a C++ instance - * around. - * - * @param debug - * allow to add extra information inside the return object such - * as the class name of the objects lefts as well as their - * numbers. - * - * @return an information object that provide useful informations for - * statistic or debuging purpose. - */ - vtkReferenceInformation gc(boolean debug); + /** + * Execute the garbage collection in the Java + VTK context to release Java + * instance that are not used anymore which keep holding a C++ instance + * around. + * + * @param debug + * allow to add extra information inside the return object such + * as the class name of the objects lefts as well as their + * numbers. + * + * @return an information object that provide useful information for + * statistic or debugging purpose. + */ + vtkReferenceInformation gc(boolean debug); - /** - * @return an helper class that allow to trigger the garbage collector at a - * given frequency inside the EDT. - */ - vtkJavaGarbageCollector getAutoGarbageCollector(); + /** + * @return an helper class that allow to trigger the garbage collector at a + * given frequency inside the EDT. + */ + vtkJavaGarbageCollector getAutoGarbageCollector(); - /** - * This method will clean up the Map of the Java objects and will release - * any vtkObject that was held by a Java one. This will prevent you from - * using any existing VTK Java object. - * - * @return the size of the map that we cleared - */ - int deleteAll(); + /** + * This method will clean up the Map of the Java objects and will release + * any vtkObject that was held by a Java one. This will prevent you from + * using any existing VTK Java object. + * + * @return the size of the map that we cleared + */ + int deleteAll(); - /** - * @return the number of vtkObject that are currently used inside the Java - * world. - */ - int getSize(); + /** + * @return the number of vtkObject that are currently used inside the Java + * world. + */ + int getSize(); - /** - * @return the vtkReferenceInformation object generated by the last gc() call - */ - vtkReferenceInformation getLastReferenceInformation(); + /** + * @return the vtkReferenceInformation object generated by the last gc() call + */ + vtkReferenceInformation getLastReferenceInformation(); }