[jboss-cvs] JBossCache/src/org/jboss/cache/pojo/jmx ...

[Brian Stansberry]

  User: bstansberry
  Date: 07/05/11 23:52:55

  Modified:    src/org/jboss/cache/pojo/jmx  PojoCacheJmxWrapperMBean.java
  Log:
  Javadoc
  
  Revision  Changes    Path
  1.4       +11 -7     JBossCache/src/org/jboss/cache/pojo/jmx/PojoCacheJmxWrapperMBean.java
  
  (In the diff below, changes in quantity of whitespace are not shown.)
  
  Index: PojoCacheJmxWrapperMBean.java
  ===================================================================
  RCS file: /cvsroot/jboss/JBossCache/src/org/jboss/cache/pojo/jmx/PojoCacheJmxWrapperMBean.java,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -b -r1.3 -r1.4
  --- PojoCacheJmxWrapperMBean.java	9 May 2007 18:22:36 -0000	1.3
  +++ PojoCacheJmxWrapperMBean.java	12 May 2007 03:52:55 -0000	1.4
  @@ -31,7 +31,7 @@
    * StandardMBean interface for {@link PojoCacheJmxWrapperMBean}.
    * 
    * @author <a href="brian.stansberry at jboss.com">Brian Stansberry</a>
  - * @version $Revision: 1.3 $
  + * @version $Revision: 1.4 $
    */
   public interface PojoCacheJmxWrapperMBean 
      extends LifeCycle
  @@ -49,18 +49,22 @@
      Configuration getConfiguration();
      
      /**
  -    * Gets whether this object should register the underlying {@link Cache}
  -    * with JMX during {@link LifeCycle#create() create()}.
  +    * Gets whether this object should register a {@link CacheJmxWrapperMBean}
  +    * for the underlying {@link Cache} with JMX.
       * <p/>
  -    * Default is <code>false</code>.
  +    * Default is <code>true</code>.
       */
      boolean getRegisterPlainCache();
   
      /**
  -    * Sets whether this object should register the underlying {@link Cache}
  -    * with JMX during {@link LifeCycle#create() create()}.
  +    * Sets whether this object should register a {@link CacheJmxWrapperMBean}
  +    * for the underlying {@link Cache} with JMX.
  +    * <p/>
  +    * Default is <code>true</code>.
       * <p/>
  -    * Default is <code>false</code>.
  +    * If <code>true</code>, the <code>CacheJmxWrapperMBean</code> will be
  +    * instantiated and registered either as part of the registration of
  +    * this object, or during the call to {@link LifeCycle#create() create()}.
       */
      public void setRegisterPlainCache(boolean registerPlainCache);