svn commit: r1711002 - /sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ObserverConfiguration.java

[cz...@apache.org]

Author: cziegeler
Date: Wed Oct 28 12:35:51 2015
New Revision: 1711002

URL: http://svn.apache.org/viewvc?rev=1711002&view=rev
Log:
SLING-5162 : Support for the new observation API in the resource resolver

Modified:
    sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ObserverConfiguration.java

Modified: sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ObserverConfiguration.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ObserverConfiguration.java?rev=1711002&r1=1711001&r2=1711002&view=diff
==============================================================================
--- sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ObserverConfiguration.java (original)
+++ sling/trunk/bundles/api/src/main/java/org/apache/sling/spi/resource/provider/ObserverConfiguration.java Wed Oct 28 12:35:51 2015
@@ -20,6 +20,8 @@ package org.apache.sling.spi.resource.pr
 
 import java.util.Set;
 
+import javax.annotation.Nonnull;
+
 import org.apache.sling.api.resource.observation.ResourceChange;
 
 import aQute.bnd.annotation.ProviderType;
@@ -30,11 +32,27 @@ import aQute.bnd.annotation.ProviderType
 @ProviderType
 public interface ObserverConfiguration {
 
+    /**
+     * {@code true} if a listener is interested in external events.
+     */
     boolean includeExternal();
 
-    Set<String> getPaths();
-
-    Set<String> getExcludedPaths();
-
-    Set<ResourceChange.ChangeType> getChangeTypes();
+    /**
+     * The set of paths this listener is interested in. Each entry is absolute.
+     * @return Non empty set of paths
+     */
+    @Nonnull Set<String> getPaths();
+
+    /**
+     * The set of excluded paths.
+     * All the paths are sub paths from one entry of {@link #getPaths()}
+     * @return A set of excluded paths, might be empty.
+     */
+    @Nonnull Set<String> getExcludedPaths();
+
+    /**
+     * The set of types listeners are interested in.
+     * @return Non empty set of types
+     */
+    @Nonnull Set<ResourceChange.ChangeType> getChangeTypes();
 }