[utilities COMMIT] in /java-support/trunk/src/main/java/net/shibboleth/utilities/java/support/service: ReloadableServ...
noreply at shibboleth.net
noreply at shibboleth.net
Tue Jul 22 11:32:21 EDT 2014
Author: rdw
Date: Tue Jul 22 11:32:21 2014
New Revision: 634
URL: http://svn.shibboleth.net/view/utilities?rev=634&view=rev
Log:
Revert previous. Move javadoc to the correct method.
Modified:
java-support/trunk/src/main/java/net/shibboleth/utilities/java/support/service/ReloadableService.java
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/ReloadableService.java
URL: http://svn.shibboleth.net/view/utilities/java-support/trunk/src/main/java/net/shibboleth/utilities/java/support/service/ReloadableService.java?rev=634&r1=633&r2=634&view=diff
==============================================================================
--- java-support/trunk/src/main/java/net/shibboleth/utilities/java/support/service/ReloadableService.java (original)
+++ java-support/trunk/src/main/java/net/shibboleth/utilities/java/support/service/ReloadableService.java Tue Jul 22 11:32:21 2014
@@ -59,7 +59,9 @@
/** Get the serviceable component that this service supports . If
* The component hasn't been successfully loaded yet or if this service
- * does not support a ServiceableComponent return null
+ * does not support a ServiceableComponent return null. If it is non-null,
+ * the returned component will be is pinned and <em>MUST</em> be unpinned by a call to
+ * {@link ServiceableComponent#unpinComponent()}.
* @return the component, if appropriate.
*/
@Nullable public ServiceableComponent<T> getServiceableComponent();
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=634&r1=633&r2=634&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:32:21 2014
@@ -34,8 +34,8 @@
public interface ServiceableComponent<T> {
/**
- * 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>.
+ * Extract the component that does the actual work. Callers <em>MUST</em> have the ServiceableComponent
+ * pinned at this stage.
*
* @return the component.
*/
More information about the commits
mailing list