diff src/org/tmatesoft/hg/util/FileIterator.java @ 444:b3b1db9301a2

Few comments that emerged while working on examples
author Artem Tikhomirov <tikhomirov.artem@gmail.com>
date Tue, 15 May 2012 20:19:22 +0200
parents 7f27122011c3
children
line wrap: on
line diff
--- a/src/org/tmatesoft/hg/util/FileIterator.java	Fri May 04 17:59:22 2012 +0200
+++ b/src/org/tmatesoft/hg/util/FileIterator.java	Tue May 15 20:19:22 2012 +0200
@@ -18,7 +18,8 @@
 
 import java.io.IOException;
 
-import org.tmatesoft.hg.internal.Experimental;
+import org.tmatesoft.hg.repo.HgStatusCollector;
+import org.tmatesoft.hg.repo.HgWorkingCopyStatusCollector;
 
 /**
  * Abstracts iteration over file system.
@@ -60,9 +61,13 @@
 	 * specific file (path) belongs to that fraction or not. Paths and files returned by this {@link FileIterator}
 	 * are always considered as representing the fraction, nonetheless, {@link FileIterator} shall return true for such names if 
 	 * asked.
+	 * <p>
+	 * Implementors are advised to use {@link Path.Matcher}, as this scope is very similar to what regular 
+	 * {@link HgStatusCollector} (which doesn't use FI) supports, and use of matcher makes {@link HgWorkingCopyStatusCollector}
+	 * look similar.
+	 * 
 	 * @return <code>true</code> if this {@link FileIterator} is responsible for (interested in) specified repository-local path 
 	 */
-	@Experimental(reason="Perhaps, shall not be part of FileIterator, but rather separate Path.Matcher. Approaches in regular StatusCollector (doesn't use FI, but supports scope) and WC collector to look similar, and for HgStatusCommand to use single approach to set the scope")
 	boolean inScope(Path file); // PathMatcher scope()
 
 	/**