Update docs for isLive and close
git-svn-id: https://svn.apache.org/repos/asf/sling/trunk@1748579 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/main/java/org/apache/sling/api/resource/ResourceResolver.java b/src/main/java/org/apache/sling/api/resource/ResourceResolver.java
index 17fc72d..19a665c 100644
--- a/src/main/java/org/apache/sling/api/resource/ResourceResolver.java
+++ b/src/main/java/org/apache/sling/api/resource/ResourceResolver.java
@@ -525,16 +525,17 @@
throws LoginException;
/**
- * Returns <code>true</code> if this resource resolver has not been closed
- * yet.
+ * Returns <code>true</code> if this resource resolver is still usable.
+ * This method tests different things like if it has not been closed
+ * yet or if any of the used resource providers is not usable anymore.
* <p>
* Unlike the other methods defined in this interface, this method will
* never throw an exception even after the resource resolver has been
* {@link #close() closed}.
*
- * @return <code>true</code> if the resource resolver has not been closed
- * yet. Once the resource resolver has been closed, this method
- * returns <code>false</code>.
+ * @return <code>true</code> if the resource resolver is still usable.
+ * Once the resource resolver has been closed or a used resource
+ * provider has been unregistered, this method returns <code>false</code>.
* @since 2.1 (Sling API Bundle 2.1.0)
*/
boolean isLive();
@@ -546,8 +547,9 @@
* exceptions if still used - with the exception of this method, which
* can be called several times with no ill effects.
*
- * A resource may also be closed implicitly in case when the {@link ResourceResolverFactory}
- * which was used to create this resolver is no longer active.
+ * A resolver may also be closed implicitly in case when the {@link ResourceResolverFactory}
+ * which was used to create this resolver is no longer active or
+ * any of the used resource providers is no longer active.
*
* @since 2.1 (Sling API Bundle 2.1.0)
* @see ResourceResolver Resource Resolver (section lifecycle)
