[Rubyeclipse-commit] SF.net SVN: rubyeclipse: [3087] trunk/org.rubypeople.rdt.core/src/org/ rubypeople/rdt/core/search

[<caw...@us...>]

Revision: 3087
          http://rubyeclipse.svn.sourceforge.net/rubyeclipse/?rev=3087&view=rev
Author:   cawilliams
Date:     2007-09-05 11:46:45 -0700 (Wed, 05 Sep 2007)

Log Message:
-----------
clean up javadocs, add more possibilities for wait flag

Modified Paths:
--------------
    trunk/org.rubypeople.rdt.core/src/org/rubypeople/rdt/core/search/IRubySearchConstants.java
    trunk/org.rubypeople.rdt.core/src/org/rubypeople/rdt/core/search/SearchEngine.java

Modified: trunk/org.rubypeople.rdt.core/src/org/rubypeople/rdt/core/search/IRubySearchConstants.java
===================================================================
--- trunk/org.rubypeople.rdt.core/src/org/rubypeople/rdt/core/search/IRubySearchConstants.java	2007-08-28 02:17:59 UTC (rev 3086)
+++ trunk/org.rubypeople.rdt.core/src/org/rubypeople/rdt/core/search/IRubySearchConstants.java	2007-09-05 18:46:45 UTC (rev 3087)
@@ -3,11 +3,6 @@
 import org.rubypeople.rdt.internal.core.search.processing.IJob;
 
 public interface IRubySearchConstants {
-	/**
-	 * The search operation waits for the underlying indexer to finish indexing 
-	 * the workspace before starting the search.
-	 */
-	int WAIT_UNTIL_READY_TO_SEARCH = IJob.WaitUntilReady;
 	
 	/**
 	 * The search result is a declaration.
@@ -91,5 +86,24 @@
 	 * More selective than using {@link #TYPE}.
 	 */
 	int MODULE= 5;
+	
+	/* Waiting policies */
+	
+	/**
+	 * The search operation starts immediately, even if the underlying indexer
+	 * has not finished indexing the workspace. Results will more likely
+	 * not contain all the matches.
+	 */
+	int FORCE_IMMEDIATE_SEARCH = IJob.ForceImmediate;
+	/**
+	 * The search operation throws an <code>org.eclipse.core.runtime.OperationCanceledException</code>
+	 * if the underlying indexer has not finished indexing the workspace.
+	 */
+	int CANCEL_IF_NOT_READY_TO_SEARCH = IJob.CancelIfNotReady;
+	/**
+	 * The search operation waits for the underlying indexer to finish indexing 
+	 * the workspace before starting the search.
+	 */
+	int WAIT_UNTIL_READY_TO_SEARCH = IJob.WaitUntilReady;
 
 }

Modified: trunk/org.rubypeople.rdt.core/src/org/rubypeople/rdt/core/search/SearchEngine.java
===================================================================
--- trunk/org.rubypeople.rdt.core/src/org/rubypeople/rdt/core/search/SearchEngine.java	2007-08-28 02:17:59 UTC (rev 3086)
+++ trunk/org.rubypeople.rdt.core/src/org/rubypeople/rdt/core/search/SearchEngine.java	2007-09-05 18:46:45 UTC (rev 3087)
@@ -59,27 +59,23 @@
 	 *   or {@link SearchPattern#R_PREFIX_MATCH} if a prefix non case sensitive match is requested.
 	 * @param searchFor determines the nature of the searched elements
 	 *	<ul>
-	 * 	<li>{@link IJavaSearchConstants#CLASS}: only look for classes</li>
-	 *		<li>{@link IJavaSearchConstants#INTERFACE}: only look for interfaces</li>
-	 * 	<li>{@link IJavaSearchConstants#ENUM}: only look for enumeration</li>
-	 *		<li>{@link IJavaSearchConstants#ANNOTATION_TYPE}: only look for annotation type</li>
-	 * 	<li>{@link IJavaSearchConstants#CLASS_AND_ENUM}: only look for classes and enumerations</li>
-	 *		<li>{@link IJavaSearchConstants#CLASS_AND_INTERFACE}: only look for classes and interfaces</li>
-	 * 	<li>{@link IJavaSearchConstants#TYPE}: look for all types (ie. classes, interfaces, enum and annotation types)</li>
+	 * 	    <li>{@link IRubySearchConstants#CLASS}: only look for classes</li>
+	 *		<li>{@link IRubySearchConstants#MODULE}: only look for modules</li>
+	 * 	    <li>{@link IRubySearchConstants#TYPE}: look for all types</li>
 	 *	</ul>
 	 * @param scope the scope to search in
 	 * @param nameRequestor the requestor that collects the results of the search
 	 * @param waitingPolicy one of
 	 * <ul>
-	 *		<li>{@link IJavaSearchConstants#FORCE_IMMEDIATE_SEARCH} if the search should start immediately</li>
-	 *		<li>{@link IJavaSearchConstants#CANCEL_IF_NOT_READY_TO_SEARCH} if the search should be cancelled if the
+	 *		<li>{@link IRubySearchConstants#FORCE_IMMEDIATE_SEARCH} if the search should start immediately</li>
+	 *		<li>{@link IRubySearchConstants#CANCEL_IF_NOT_READY_TO_SEARCH} if the search should be cancelled if the
 	 *			underlying indexer has not finished indexing the workspace</li>
-	 *		<li>{@link IJavaSearchConstants#WAIT_UNTIL_READY_TO_SEARCH} if the search should wait for the
+	 *		<li>{@link IRubySearchConstants#WAIT_UNTIL_READY_TO_SEARCH} if the search should wait for the
 	 *			underlying indexer to finish indexing the workspace</li>
 	 * </ul>
 	 * @param progressMonitor the progress monitor to report progress to, or <code>null</code> if no progress
 	 *							monitor is provided
-	 * @exception JavaModelException if the search failed. Reasons include:
+	 * @exception RubyModelException if the search failed. Reasons include:
 	 *	<ul>
 	 *		<li>the classpath is incorrectly set</li>
 	 *	</ul>


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.