[utilities COMMIT] /java-support/trunk/src/main/java/net/shibboleth/utilities/java/support/service/ServiceableCompone...

[noreply at shibboleth.net]

Author: rdw
Date: Tue Jul 22 11:22:28 2014
New Revision: 633

URL: http://svn.shibboleth.net/view/utilities?rev=633&view=rev
Log:
Clear up javadoc wrt the pinning action of getComponent.

Modified:
    java-support/trunk/src/main/java/net/shibboleth/utilities/java/support/service/ServiceableComponent.java

Modified: java-support/trunk/src/main/java/net/shibboleth/utilities/java/support/service/ServiceableComponent.java
URL: http://svn.shibboleth.net/view/utilities/java-support/trunk/src/main/java/net/shibboleth/utilities/java/support/service/ServiceableComponent.java?rev=633&r1=632&r2=633&view=diff
==============================================================================
--- java-support/trunk/src/main/java/net/shibboleth/utilities/java/support/service/ServiceableComponent.java (original)
+++ java-support/trunk/src/main/java/net/shibboleth/utilities/java/support/service/ServiceableComponent.java Tue Jul 22 11:22:28 2014
@@ -34,8 +34,8 @@
 public interface ServiceableComponent<T> {
 
     /**
-     * Extract the component that does the actual work.  Callers <em>MUST</em> have the ServiceableComponent
-     * pinned at this stage.
+     * Extract the component that does the actual work.  When this returns the component is pinned<br/>
+     * <em>Every call to {@link #getComponent()} must be matched by a call to {@link #unpinComponent()}</em>. 
      *
      * @return the component.       
      */
@@ -43,7 +43,7 @@
     
     /**
      * This function takes a lock on the component which guarantees that it will not be disposed until the unpin call
-     * is made.<br/>
+     * is made.<br/> This method is typically <em>only</em> used during intialization of the component.<br/> 
      * <em>Every call to {@link #pinComponent()} must be matched by a call to {@link #unpinComponent()}</em>. 
      */
     public void pinComponent();