Author: cziegeler
Date: Tue Oct 18 14:20:18 2016
New Revision: 1765443
URL: http://svn.apache.org/viewvc?rev=1765443&view=rev
Log:
Update javadoc
Modified:
sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ProviderContext.java
Modified:
sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ProviderContext.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ProviderContext.java?rev=1765443&r1=1765442&r2=1765443&view=diff
==============================================================================
---
sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ProviderContext.java
(original)
+++
sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ProviderContext.java
Tue Oct 18 14:20:18 2016
@@ -39,12 +39,22 @@ public interface ProviderContext {
/**
* Get the observation reporter for this instance.
+ * If anything related to observation configuration changes,
+ * {@link ResourceProvider#update(long)} is called. From that point on
+ * this method needs to be called to get the updated/new observation
+ * reporter. The instance previously returned (before update was called)
+ * becomes invalid and must not be used anymore.
+ *
* @return The observation reporter.
*/
@Nonnull ObservationReporter getObservationReporter();
/**
* Set of paths which are "hidden" by other resource providers.
+ * If anything related to observation configuration changes,
+ * {@link ResourceProvider#update(long)} is called. From that point on
+ * this method will return a new path set with the updated/changed
+ * exclude paths.
* @return A set of paths. The set might be empty
*/
PathSet getExcludedPaths();