svn commit: rev 30850 - excalibur/trunk/containerkit/instrument/api/src/java/org/apache/excalibur/instrument

[le...@apache.org]

Author: leif
Date: Wed Jul 28 09:53:21 2004
New Revision: 30850

Modified:
   excalibur/trunk/containerkit/instrument/api/src/java/org/apache/excalibur/instrument/ValueInstrument.java
Log:
Improve the setValue javadocs.

Modified: excalibur/trunk/containerkit/instrument/api/src/java/org/apache/excalibur/instrument/ValueInstrument.java
==============================================================================
--- excalibur/trunk/containerkit/instrument/api/src/java/org/apache/excalibur/instrument/ValueInstrument.java	(original)
+++ excalibur/trunk/containerkit/instrument/api/src/java/org/apache/excalibur/instrument/ValueInstrument.java	Wed Jul 28 09:53:21 2004
@@ -50,6 +50,15 @@
      * Sets the current value of the Instrument.  This method is optimized
      *  to be extremely light weight when an InstrumentManager is not present
      *  and there are no registered ValueInstrumentListeners.
+     * <p>
+     * Note that in many cases is best to call this method even if the
+     *  isActive() method returns false.  This is because the InstrumentManager
+     *  will remember the last value set and use it if the instrument ever
+     *  becomes active.  For things like pool sizes which do not change often,
+     *  this behavior is critical so that users can begin monitoring the value
+     *  and see what it was before they connected.   Setting the value is
+     *  very light weight, but its calculation may not be.  It is up to the
+     *  user to weigh the benefits and consequences one way or the other.
      *
      * @param value The new value for the Instrument.
      */

---------------------------------------------------------------------
To unsubscribe, e-mail: scm-unsubscribe@excalibur.apache.org
For additional commands, e-mail: scm-help@excalibur.apache.org