[java-identity-provider COMMIT] /trunk/idp-core/src/main/java/net/shibboleth/idp/service/ServiceableComponent.java

[noreply at shibboleth.net]

Author: iay
Date: Thu Jul  3 06:44:51 2014
New Revision: 6211

URL: http://svn.shibboleth.net/view/java-identity-provider?rev=6211&view=rev
Log:
Fix up some rotted Javadoc.

Modified:
    trunk/idp-core/src/main/java/net/shibboleth/idp/service/ServiceableComponent.java

Modified: trunk/idp-core/src/main/java/net/shibboleth/idp/service/ServiceableComponent.java
URL: http://svn.shibboleth.net/view/java-identity-provider/trunk/idp-core/src/main/java/net/shibboleth/idp/service/ServiceableComponent.java?rev=6211&r1=6210&r2=6211&view=diff
==============================================================================
--- trunk/idp-core/src/main/java/net/shibboleth/idp/service/ServiceableComponent.java (original)
+++ trunk/idp-core/src/main/java/net/shibboleth/idp/service/ServiceableComponent.java Thu Jul  3 06:44:51 2014
@@ -20,8 +20,7 @@
 import javax.annotation.Nonnull;
 
 /**
- * Any Component that wants to be reloaded via the Service interface and spring implements this interface.
- * @param <T> The underlying type of the component.
+ * Any component that wants to be reloaded via the Service interface and Spring implements this interface.
  * 
  * The idea is that the attribute resolver will be
  * <code>
@@ -29,6 +28,8 @@
  *  AttributeResolver, ServiceableComponent<ServiceableComponent>.
  *  </code>
  *  AbstractServiceableComponent will do all the work around reload and synchronization.
+ *  
+ * @param <T> The underlying type of the component.
  */
 public interface ServiceableComponent<T> {
 
@@ -41,15 +42,14 @@
     @Nonnull public T getComponent();
     
     /**
-     * This function takes a lock on the component which guarantees that it will not be disposed until the release call
+     * This function takes a lock on the component which guarantees that it will not be disposed until the unpin call
      * is made.<br/>
-     * <em>Every call to {@link #pinComponent()} must be matched by a call to {@link #unpinComponent()}</em>
-     * <br/> The need to have the type converting return parameter is to get around the java typing restrictions. 
+     * <em>Every call to {@link #pinComponent()} must be matched by a call to {@link #unpinComponent()}</em>. 
      */
     public void pinComponent();
 
     /**
-     * This undoes the work that is done by {@link #getComponent()}.
+     * This undoes the work that is done by {@link #pinComponent()}.
      */
     public void unpinComponent();
     
@@ -59,6 +59,5 @@
      * calls dispose on the components.  <br/>Implementations should avoid calling
      * this with locks held.
      */
-    
     public void unloadComponent();
 }