[Javaprofiler-commits] CVS: jpi/net/sourceforge/javaprofiler/jpi AllocStat.java,1.3,1.4

[Michal P. <mic...@us...>]

Update of /cvsroot/javaprofiler/jpi/net/sourceforge/javaprofiler/jpi
In directory usw-pr-cvs1:/tmp/cvs-serv22478/net/sourceforge/javaprofiler/jpi

Modified Files:
	AllocStat.java 
Log Message:

Javadoc.


Index: AllocStat.java
===================================================================
RCS file: /cvsroot/javaprofiler/jpi/net/sourceforge/javaprofiler/jpi/AllocStat.java,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -r1.3 -r1.4
*** AllocStat.java	2 Jul 2002 20:18:29 -0000	1.3
--- AllocStat.java	10 Sep 2002 10:55:23 -0000	1.4
***************
*** 21,31 ****
  package net.sourceforge.javaprofiler.jpi;
  
  public interface AllocStat {
      long getLiveInstancesCount();
      long getTotalInstancesCount();
      long getLiveInstancesSize();
-     long getTotalInstancesSize();
      
      void addAllocStatListener( AllocStatListener listener);
      void removeAllocStatListener( AllocStatListener listener);
  }
--- 21,61 ----
  package net.sourceforge.javaprofiler.jpi;
  
+ /**
+  * Interface representing object that contains memory related information. It is often inherited
+  * by other interfaces.
+  */
+ 
  public interface AllocStat {
+     
+     /**
+      * Returns the number of live instances. Live instance is that one that has not been
+      * garbage collected (or marked for garbage collection).
+      */
      long getLiveInstancesCount();
+ 
+     /**
+      * Returns the total number of instances. It does not matter whether the instance is live
+      * or garbage collected.
+      */
      long getTotalInstancesCount();
+ 
+     /**
+      * Computes and returns the space occupied by allocated instances.
+      */
      long getLiveInstancesSize();
      
+     /**
+      * Sums the space occupied by both allocated and garbage collected instances.
+      */
+     long getTotalInstancesSize();
+ 
+     /**
+      * Adds an event listener.
+      */
      void addAllocStatListener( AllocStatListener listener);
+ 
+     /**
+      * Removes the specified event listener.
+      */
      void removeAllocStatListener( AllocStatListener listener);
  }
***************
*** 33,38 ****
  /*
   * $Log$
   * Revision 1.3  2002/07/02 20:18:29  stolis
   * License added.
   *
!  */
\ No newline at end of file
--- 63,72 ----
  /*
   * $Log$
+  * Revision 1.4  2002/09/10 10:55:23  michalpise
+  *
+  * Javadoc.
+  *
   * Revision 1.3  2002/07/02 20:18:29  stolis
   * License added.
   *
!  */