svn commit: r1545675 - /jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/observation/filter/FilterProvider.java

[mduerig]

Author: mduerig
Date: Tue Nov 26 14:38:54 2013
New Revision: 1545675

URL: http://svn.apache.org/r1545675
Log:
OAK-1133: Observation listener PLUS
Javadoc

Modified:
    
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/observation/filter/FilterProvider.java

Modified: 
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/observation/filter/FilterProvider.java
URL: 
http://svn.apache.org/viewvc/jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/observation/filter/FilterProvider.java?rev=1545675&r1=1545674&r2=1545675&view=diff
==============================================================================
--- 
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/observation/filter/FilterProvider.java
 (original)
+++ 
jackrabbit/oak/trunk/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/observation/filter/FilterProvider.java
 Tue Nov 26 14:38:54 2013
@@ -47,19 +47,22 @@ public interface FilterProvider {
     boolean includeCommit(@Nonnull String sessionId, @CheckForNull CommitInfo 
info);
 
     /**
-     * TODO document
-     * @param beforeTree
-     * @param afterTree
-     * @param treePermission
-     * @return
+     * Factory method for creating a {@code Filter} for the passed before and 
after
+     * states and the given tree permissions of the reading session.
+     *
+     * @param beforeTree  before state
+     * @param afterTree   after state
+     * @param treePermission  tree permission of the corresponding tree of the 
reading session
+     * @return new {@code Filter} instance
      */
     @Nonnull
     Filter getFilter(@Nonnull ImmutableTree beforeTree, @Nonnull ImmutableTree 
afterTree,
             @Nonnull TreePermission treePermission);
 
     /**
-     * TODO document
-     * @return
+     * Path of the subtree to which the the filter returned by
+     * {@link #getFilter(ImmutableTree, ImmutableTree, TreePermission)} 
applies.
+     * @return path to which the filter applies.
      */
     @Nonnull
     String getPath();