Improve comments
authormarkt <markt@13f79535-47bb-0310-9956-ffa450edef68>
Tue, 8 Feb 2011 14:28:30 +0000 (14:28 +0000)
committermarkt <markt@13f79535-47bb-0310-9956-ffa450edef68>
Tue, 8 Feb 2011 14:28:30 +0000 (14:28 +0000)
git-svn-id: https://svn.apache.org/repos/asf/tomcat/trunk@1068415 13f79535-47bb-0310-9956-ffa450edef68

java/org/apache/catalina/util/LifecycleMBeanBase.java

index 346957c..2939d92 100644 (file)
@@ -132,8 +132,8 @@ public abstract class LifecycleMBeanBase extends LifecycleBase
      * Utility method to enable sub-classes to easily register additional
      * components that don't implement {@link MBeanRegistration} with
      * an MBean server.<br/>
-     * Note: This method can only be used once {@link #initInternal()} has been
-     * called. 
+     * Note: This method should only be used once {@link #initInternal()} has
+     * been called and before {@link #destroyInternal()} has been called. 
      * 
      * @param obj                       The object the register
      * @param objectNameKeyProperties   The key properties component of the
@@ -171,7 +171,10 @@ public abstract class LifecycleMBeanBase extends LifecycleBase
     /**
      * Utility method to enable sub-classes to easily unregister additional
      * components that don't implement {@link MBeanRegistration} with
-     * an MBean server.
+     * an MBean server.<br/>
+     * Note: This method should only be used once {@link #initInternal()} has
+     * been called and before {@link #destroyInternal()} has been called. 
+     * 
      * @param on    The name of the component to unregister
      */
     protected final void unregister(ObjectName on) {