jakarta-jcs-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From asm...@apache.org
Subject svn commit: r705666 - in /jakarta/jcs/trunk/src/java/org/apache/jcs/engine/stats: CacheStats.java StatElement.java behavior/ICacheStats.java behavior/IStatElement.java
Date Fri, 17 Oct 2008 16:37:50 GMT
Author: asmuts
Date: Fri Oct 17 09:37:50 2008
New Revision: 705666

URL: http://svn.apache.org/viewvc?rev=705666&view=rev
Log:
Fixing javadocs and formatting

Modified:
    jakarta/jcs/trunk/src/java/org/apache/jcs/engine/stats/CacheStats.java
    jakarta/jcs/trunk/src/java/org/apache/jcs/engine/stats/StatElement.java
    jakarta/jcs/trunk/src/java/org/apache/jcs/engine/stats/behavior/ICacheStats.java
    jakarta/jcs/trunk/src/java/org/apache/jcs/engine/stats/behavior/IStatElement.java

Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/engine/stats/CacheStats.java
URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/src/java/org/apache/jcs/engine/stats/CacheStats.java?rev=705666&r1=705665&r2=705666&view=diff
==============================================================================
--- jakarta/jcs/trunk/src/java/org/apache/jcs/engine/stats/CacheStats.java (original)
+++ jakarta/jcs/trunk/src/java/org/apache/jcs/engine/stats/CacheStats.java Fri Oct 17 09:37:50
2008
@@ -25,58 +25,55 @@
 
 /**
  * This class stores cache historical and statistics data for a region.
- *
+ * <p>
  * Only the composite cache knows what the hit count across all auxiliaries is.
- *
- * @author aaronsm
- *
  */
 public class CacheStats
     extends Stats
     implements ICacheStats
 {
+    /** Don't change. */
     private static final long serialVersionUID = 529914708798168590L;
 
+    /** The region */
     private String regionName = null;
 
+    /** What that auxiliaries are reporting. */
     private IStats[] auxStats = null;
 
+    /** stats */
     private IStatElement[] stats = null;
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.apache.jcs.engine.stats.behavior.ICacheStats#getRegionName()
+    /**
+     * Stats are for a region, though auxiliary data may be for more.
+     * <p>
+     * @return The region name
      */
     public String getRegionName()
     {
         return regionName;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.apache.jcs.engine.stats.behavior.ICacheStats#setRegionName(java.lang.String)
+    /**
+     * Stats are for a region, though auxiliary data may be for more.
+     * <p>
+     * @param name - The region name
      */
     public void setRegionName( String name )
     {
         regionName = name;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.apache.jcs.engine.stats.behavior.ICacheStats#getAuxiliaryCacheStats()
+    /**
+     * @return IStats[]
      */
     public IStats[] getAuxiliaryCacheStats()
     {
         return auxStats;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.apache.jcs.engine.stats.behavior.ICacheStats#setAuxiliaryCacheStats(org.apache.jcs.engine.stats.behavior.IAuxiliaryCacheStats[])
+    /**
+     * @param stats
      */
     public void setAuxiliaryCacheStats( IStats[] stats )
     {
@@ -84,8 +81,9 @@
     }
 
     /**
-     * This returns data about the auxiliaries, such as hit count. Only the
-     * composite cache knows what the hit count across all auxiliaries is.
+     * This returns data about the auxiliaries, such as hit count. Only the composite cache
knows
+     * what the hit count across all auxiliaries is.
+     * <p>
      * @return IStatElement[]
      */
     public IStatElement[] getStatElements()
@@ -93,20 +91,16 @@
         return stats;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.apache.jcs.engine.stats.behavior.IStats#setStatElements(org.apache.jcs.engine.stats.behavior.IStatElement[])
+    /**
+     * @param stats
      */
     public void setStatElements( IStatElement[] stats )
     {
         this.stats = stats;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.lang.Object#toString()
+    /**
+     * @return readable string that can be logged.
      */
     public String toString()
     {

Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/engine/stats/StatElement.java
URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/src/java/org/apache/jcs/engine/stats/StatElement.java?rev=705666&r1=705665&r2=705666&view=diff
==============================================================================
--- jakarta/jcs/trunk/src/java/org/apache/jcs/engine/stats/StatElement.java (original)
+++ jakarta/jcs/trunk/src/java/org/apache/jcs/engine/stats/StatElement.java Fri Oct 17 09:37:50
2008
@@ -21,63 +21,58 @@
 
 import org.apache.jcs.engine.stats.behavior.IStatElement;
 
-
 /**
- * @author aaronsm
- *
+ * This is a stat data holder.
  */
 public class StatElement
     implements IStatElement
 {
-
+    /** name of the stat */
     private String name = null;
 
+    /** the data */
     private String data = null;
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.apache.jcs.engine.stats.behavior.IStatElement#getName()
+    /**
+     * Get the name of the stat element, ex. HitCount
+     * <p>
+     * @return the stat element name
      */
     public String getName()
     {
         return name;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.apache.jcs.engine.stats.behavior.IStatElement#setName(java.lang.String)
+    /**
+     * @param name
      */
     public void setName( String name )
     {
         this.name = name;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.apache.jcs.engine.stats.behavior.IStatElement#getData()
+    /**
+     * Get the data, ex. for hit count you would get a String value for some number.
+     * <p>
+     * @return String data
      */
     public String getData()
     {
         return data;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see org.apache.jcs.engine.stats.behavior.IStatElement#setData(java.lang.String)
+    /**
+     * Set the data for this element.
+     * <p>
+     * @param data
      */
     public void setData( String data )
     {
         this.data = data;
     }
 
-    /*
-     * (non-Javadoc)
-     *
-     * @see java.lang.Object#toString()
+    /**
+     * @return a readable string.
      */
     public String toString()
     {

Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/engine/stats/behavior/ICacheStats.java
URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/src/java/org/apache/jcs/engine/stats/behavior/ICacheStats.java?rev=705666&r1=705665&r2=705666&view=diff
==============================================================================
--- jakarta/jcs/trunk/src/java/org/apache/jcs/engine/stats/behavior/ICacheStats.java (original)
+++ jakarta/jcs/trunk/src/java/org/apache/jcs/engine/stats/behavior/ICacheStats.java Fri Oct
17 09:37:50 2008
@@ -20,39 +20,30 @@
  */
 
 /**
- * This holds stat information on a region. It contains both auxiliary and core
- * stats.
- *
- * @author aaronsm
- *
+ * This holds stat information on a region. It contains both auxiliary and core stats.
  */
 public interface ICacheStats
     extends IStats
 {
-
     /**
      * Stats are for a region, though auxiliary data may be for more.
-     *
+     * <p>
      * @return The region name
      */
     public abstract String getRegionName();
 
     /**
-     *
      * @param name
      */
     public abstract void setRegionName( String name );
 
     /**
-     *
-     * @return
+     * @return IStats[]
      */
     public abstract IStats[] getAuxiliaryCacheStats();
 
     /**
-     *
      * @param stats
      */
     public abstract void setAuxiliaryCacheStats( IStats[] stats );
-
 }

Modified: jakarta/jcs/trunk/src/java/org/apache/jcs/engine/stats/behavior/IStatElement.java
URL: http://svn.apache.org/viewvc/jakarta/jcs/trunk/src/java/org/apache/jcs/engine/stats/behavior/IStatElement.java?rev=705666&r1=705665&r2=705666&view=diff
==============================================================================
--- jakarta/jcs/trunk/src/java/org/apache/jcs/engine/stats/behavior/IStatElement.java (original)
+++ jakarta/jcs/trunk/src/java/org/apache/jcs/engine/stats/behavior/IStatElement.java Fri
Oct 17 09:37:50 2008
@@ -21,39 +21,32 @@
 
 /**
  * IAuxiliaryCacheStats will hold these IStatElements.
- *
- * @author aaronsm
- *
  */
 public interface IStatElement
 {
-
     /**
      * Get the name of the stat element, ex. HitCount
-     *
+     * <p>
      * @return the stat element name
      */
     public abstract String getName();
 
     /**
-     *
      * @param name
      */
     public abstract void setName( String name );
 
     /**
-     * Get the data, ex. for hit count you would get a String value for some
-     * number.
-     *
+     * Get the data, ex. for hit count you would get a String value for some number.
+     * <p>
      * @return String data
      */
     public abstract String getData();
 
     /**
      * Set the data for this element.
-     *
+     * <p>
      * @param data
      */
     public abstract void setData( String data );
-
 }



---------------------------------------------------------------------
To unsubscribe, e-mail: jcs-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: jcs-dev-help@jakarta.apache.org


Mime
View raw message