| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.5.0_12) on Fri May 30 11:16:00 CDT 2008 --> |
| <TITLE> |
| SearchEngine |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.eclipse.wst.jsdt.core.search.SearchEngine class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="SearchEngine"; |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SearchEngine.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchDocument.html" title="class in org.eclipse.wst.jsdt.core.search"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchMatch.html" title="class in org.eclipse.wst.jsdt.core.search"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../index.html?org/eclipse/wst/jsdt/core/search/SearchEngine.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="SearchEngine.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.eclipse.wst.jsdt.core.search</FONT> |
| <BR> |
| Class SearchEngine</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.eclipse.wst.jsdt.core.search.SearchEngine</B> |
| </PRE> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>SearchEngine</B><DT>extends java.lang.Object</DL> |
| </PRE> |
| |
| <P> |
| A <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchEngine.html" title="class in org.eclipse.wst.jsdt.core.search"><CODE>SearchEngine</CODE></A> searches for JavaScript elements following a search pattern. |
| The search can be limited to a search scope. |
| <p> |
| Various search patterns can be created using the factory methods |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#createPattern(java.lang.String, int, int, int)"><CODE>SearchPattern.createPattern(String, int, int, int)</CODE></A>, <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#createPattern(org.eclipse.wst.jsdt.core.IJavaScriptElement, int)"><CODE>SearchPattern.createPattern(IJavaScriptElement, int)</CODE></A>, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#createOrPattern(org.eclipse.wst.jsdt.core.search.SearchPattern, org.eclipse.wst.jsdt.core.search.SearchPattern)"><CODE>SearchPattern.createOrPattern(SearchPattern, SearchPattern)</CODE></A>. |
| </p> |
| <p>For example, one can search for references to a method in the hierarchy of a type, |
| or one can search for the declarations of types starting with "Abstract" in a project. |
| </p> |
| <p> |
| This class may be instantiated; it is not intended to be subclassed. |
| </p> |
| |
| Provisional API: This class/interface is part of an interim API that is still under development and expected to |
| change significantly before reaching stability. It is being made available at this early stage to solicit feedback |
| from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken |
| (repeatedly) as the API evolves. |
| <P> |
| |
| <P> |
| <HR> |
| |
| <P> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchEngine.html#SearchEngine()">SearchEngine</A></B>()</CODE> |
| |
| <BR> |
| Creates a new search engine.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchEngine.html#SearchEngine(org.eclipse.wst.jsdt.core.IJavaScriptUnit[])">SearchEngine</A></B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptUnit.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptUnit</A>[] workingCopies)</CODE> |
| |
| <BR> |
| Creates a new search engine with a list of working copies that will take precedence over |
| their original javascript unit s in the subsequent search operations.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchEngine.html#SearchEngine(org.eclipse.wst.jsdt.core.WorkingCopyOwner)">SearchEngine</A></B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/core/WorkingCopyOwner.html" title="class in org.eclipse.wst.jsdt.core">WorkingCopyOwner</A> workingCopyOwner)</CODE> |
| |
| <BR> |
| Creates a new search engine with the given working copy owner.</TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchScope.html" title="interface in org.eclipse.wst.jsdt.core.search">IJavaScriptSearchScope</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchEngine.html#createHierarchyScope(org.eclipse.wst.jsdt.core.IType)">createHierarchyScope</A></B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IType.html" title="interface in org.eclipse.wst.jsdt.core">IType</A> type)</CODE> |
| |
| <BR> |
| Returns a JavaScript search scope limited to the hierarchy of the given type.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchScope.html" title="interface in org.eclipse.wst.jsdt.core.search">IJavaScriptSearchScope</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchEngine.html#createHierarchyScope(org.eclipse.wst.jsdt.core.IType, org.eclipse.wst.jsdt.core.WorkingCopyOwner)">createHierarchyScope</A></B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IType.html" title="interface in org.eclipse.wst.jsdt.core">IType</A> type, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/WorkingCopyOwner.html" title="class in org.eclipse.wst.jsdt.core">WorkingCopyOwner</A> owner)</CODE> |
| |
| <BR> |
| Returns a JavaScript search scope limited to the hierarchy of the given type.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchScope.html" title="interface in org.eclipse.wst.jsdt.core.search">IJavaScriptSearchScope</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchEngine.html#createJavaSearchScope(org.eclipse.wst.jsdt.core.IJavaScriptElement[])">createJavaSearchScope</A></B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A>[] elements)</CODE> |
| |
| <BR> |
| Returns a JavaScript search scope limited to the given JavaScript elements.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchScope.html" title="interface in org.eclipse.wst.jsdt.core.search">IJavaScriptSearchScope</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchEngine.html#createJavaSearchScope(org.eclipse.wst.jsdt.core.IJavaScriptElement[], boolean)">createJavaSearchScope</A></B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A>[] elements, |
| boolean includeReferencedProjects)</CODE> |
| |
| <BR> |
| Returns a JavaScript search scope limited to the given JavaScript elements.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchScope.html" title="interface in org.eclipse.wst.jsdt.core.search">IJavaScriptSearchScope</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchEngine.html#createJavaSearchScope(org.eclipse.wst.jsdt.core.IJavaScriptElement[], int)">createJavaSearchScope</A></B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A>[] elements, |
| int includeMask)</CODE> |
| |
| <BR> |
| Returns a JavaScript search scope limited to the given JavaScript elements.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/TypeNameMatch.html" title="class in org.eclipse.wst.jsdt.core.search">TypeNameMatch</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchEngine.html#createTypeNameMatch(org.eclipse.wst.jsdt.core.IType, int)">createTypeNameMatch</A></B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IType.html" title="interface in org.eclipse.wst.jsdt.core">IType</A> type, |
| int modifiers)</CODE> |
| |
| <BR> |
| Create a type name match on a given type with specific modifiers.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchScope.html" title="interface in org.eclipse.wst.jsdt.core.search">IJavaScriptSearchScope</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchEngine.html#createWorkspaceScope()">createWorkspaceScope</A></B>()</CODE> |
| |
| <BR> |
| Returns a JavaScript search scope with the workspace as the only limit.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchParticipant.html" title="class in org.eclipse.wst.jsdt.core.search">SearchParticipant</A></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchEngine.html#getDefaultSearchParticipant()">getDefaultSearchParticipant</A></B>()</CODE> |
| |
| <BR> |
| Returns a new default JavaScript search participant.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchEngine.html#search(org.eclipse.wst.jsdt.core.search.SearchPattern, org.eclipse.wst.jsdt.core.search.SearchParticipant[], org.eclipse.wst.jsdt.core.search.IJavaScriptSearchScope, org.eclipse.wst.jsdt.core.search.SearchRequestor, IProgressMonitor)">search</A></B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html" title="class in org.eclipse.wst.jsdt.core.search">SearchPattern</A> pattern, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchParticipant.html" title="class in org.eclipse.wst.jsdt.core.search">SearchParticipant</A>[] participants, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchScope.html" title="interface in org.eclipse.wst.jsdt.core.search">IJavaScriptSearchScope</A> scope, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchRequestor.html" title="class in org.eclipse.wst.jsdt.core.search">SearchRequestor</A> requestor, |
| IProgressMonitor monitor)</CODE> |
| |
| <BR> |
| Searches for matches of a given search pattern.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchEngine.html#searchAllTypeNames(char[][], char[][], org.eclipse.wst.jsdt.core.search.IJavaScriptSearchScope, org.eclipse.wst.jsdt.core.search.TypeNameMatchRequestor, int, IProgressMonitor)">searchAllTypeNames</A></B>(char[][] qualifications, |
| char[][] typeNames, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchScope.html" title="interface in org.eclipse.wst.jsdt.core.search">IJavaScriptSearchScope</A> scope, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/TypeNameMatchRequestor.html" title="class in org.eclipse.wst.jsdt.core.search">TypeNameMatchRequestor</A> nameMatchRequestor, |
| int waitingPolicy, |
| IProgressMonitor progressMonitor)</CODE> |
| |
| <BR> |
| Searches for all top-level types and member types in the given scope matching any of the given qualifications |
| and type names in a case sensitive way.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchEngine.html#searchAllTypeNames(char[][], char[][], org.eclipse.wst.jsdt.core.search.IJavaScriptSearchScope, org.eclipse.wst.jsdt.core.search.TypeNameRequestor, int, IProgressMonitor)">searchAllTypeNames</A></B>(char[][] qualifications, |
| char[][] typeNames, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchScope.html" title="interface in org.eclipse.wst.jsdt.core.search">IJavaScriptSearchScope</A> scope, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/TypeNameRequestor.html" title="class in org.eclipse.wst.jsdt.core.search">TypeNameRequestor</A> nameRequestor, |
| int waitingPolicy, |
| IProgressMonitor progressMonitor)</CODE> |
| |
| <BR> |
| Searches for all top-level types and member types in the given scope matching any of the given qualifications |
| and type names in a case sensitive way.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchEngine.html#searchAllTypeNames(char[], int, char[], int, int, org.eclipse.wst.jsdt.core.search.IJavaScriptSearchScope, org.eclipse.wst.jsdt.core.search.TypeNameMatchRequestor, int, IProgressMonitor)">searchAllTypeNames</A></B>(char[] packageName, |
| int packageMatchRule, |
| char[] typeName, |
| int typeMatchRule, |
| int searchFor, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchScope.html" title="interface in org.eclipse.wst.jsdt.core.search">IJavaScriptSearchScope</A> scope, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/TypeNameMatchRequestor.html" title="class in org.eclipse.wst.jsdt.core.search">TypeNameMatchRequestor</A> nameMatchRequestor, |
| int waitingPolicy, |
| IProgressMonitor progressMonitor)</CODE> |
| |
| <BR> |
| Searches for all top-level types and member types in the given scope.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchEngine.html#searchAllTypeNames(char[], int, char[], int, int, org.eclipse.wst.jsdt.core.search.IJavaScriptSearchScope, org.eclipse.wst.jsdt.core.search.TypeNameRequestor, int, IProgressMonitor)">searchAllTypeNames</A></B>(char[] packageName, |
| int packageMatchRule, |
| char[] typeName, |
| int typeMatchRule, |
| int searchFor, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchScope.html" title="interface in org.eclipse.wst.jsdt.core.search">IJavaScriptSearchScope</A> scope, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/TypeNameRequestor.html" title="class in org.eclipse.wst.jsdt.core.search">TypeNameRequestor</A> nameRequestor, |
| int waitingPolicy, |
| IProgressMonitor progressMonitor)</CODE> |
| |
| <BR> |
| Searches for all top-level types and member types in the given scope.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchEngine.html#searchDeclarationsOfAccessedFields(org.eclipse.wst.jsdt.core.IJavaScriptElement, org.eclipse.wst.jsdt.core.search.SearchRequestor, IProgressMonitor)">searchDeclarationsOfAccessedFields</A></B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A> enclosingElement, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchRequestor.html" title="class in org.eclipse.wst.jsdt.core.search">SearchRequestor</A> requestor, |
| IProgressMonitor monitor)</CODE> |
| |
| <BR> |
| Searches for all declarations of the fields accessed in the given element.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchEngine.html#searchDeclarationsOfReferencedTypes(org.eclipse.wst.jsdt.core.IJavaScriptElement, org.eclipse.wst.jsdt.core.search.SearchRequestor, IProgressMonitor)">searchDeclarationsOfReferencedTypes</A></B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A> enclosingElement, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchRequestor.html" title="class in org.eclipse.wst.jsdt.core.search">SearchRequestor</A> requestor, |
| IProgressMonitor monitor)</CODE> |
| |
| <BR> |
| Searches for all declarations of the types referenced in the given element.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchEngine.html#searchDeclarationsOfSentMessages(org.eclipse.wst.jsdt.core.IJavaScriptElement, org.eclipse.wst.jsdt.core.search.SearchRequestor, IProgressMonitor)">searchDeclarationsOfSentMessages</A></B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A> enclosingElement, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchRequestor.html" title="class in org.eclipse.wst.jsdt.core.search">SearchRequestor</A> requestor, |
| IProgressMonitor monitor)</CODE> |
| |
| <BR> |
| Searches for all declarations of the methods invoked in the given element.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="SearchEngine()"><!-- --></A><H3> |
| SearchEngine</H3> |
| <PRE> |
| public <B>SearchEngine</B>()</PRE> |
| <DL> |
| <DD>Creates a new search engine. |
| <P> |
| </DL> |
| <HR> |
| |
| <A NAME="SearchEngine(org.eclipse.wst.jsdt.core.IJavaScriptUnit[])"><!-- --></A><H3> |
| SearchEngine</H3> |
| <PRE> |
| public <B>SearchEngine</B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptUnit.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptUnit</A>[] workingCopies)</PRE> |
| <DL> |
| <DD>Creates a new search engine with a list of working copies that will take precedence over |
| their original javascript unit s in the subsequent search operations. |
| <p> |
| Note that passing an empty working copy will be as if the original compilation |
| unit had been deleted.</p> |
| <p> |
| Since 3.0 the given working copies take precedence over primary working copies (if any). |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>workingCopies</CODE> - the working copies that take precedence over their original javascript unit s</DL> |
| </DL> |
| <HR> |
| |
| <A NAME="SearchEngine(org.eclipse.wst.jsdt.core.WorkingCopyOwner)"><!-- --></A><H3> |
| SearchEngine</H3> |
| <PRE> |
| public <B>SearchEngine</B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/core/WorkingCopyOwner.html" title="class in org.eclipse.wst.jsdt.core">WorkingCopyOwner</A> workingCopyOwner)</PRE> |
| <DL> |
| <DD>Creates a new search engine with the given working copy owner. |
| The working copies owned by this owner will take precedence over |
| the primary javascript unit s in the subsequent search operations. |
| <P> |
| <DL> |
| <DT><B>Parameters:</B><DD><CODE>workingCopyOwner</CODE> - the owner of the working copies that take precedence over their original javascript unit s</DL> |
| </DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="createHierarchyScope(org.eclipse.wst.jsdt.core.IType)"><!-- --></A><H3> |
| createHierarchyScope</H3> |
| <PRE> |
| public static <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchScope.html" title="interface in org.eclipse.wst.jsdt.core.search">IJavaScriptSearchScope</A> <B>createHierarchyScope</B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IType.html" title="interface in org.eclipse.wst.jsdt.core">IType</A> type) |
| throws <A HREF="../../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Returns a JavaScript search scope limited to the hierarchy of the given type. |
| The JavaScript elements resulting from a search with this scope will |
| be types in this hierarchy, or members of the types in this hierarchy. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>type</CODE> - the focus of the hierarchy scope |
| <DT><B>Returns:</B><DD>a new hierarchy scope |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if the hierarchy could not be computed on the given type</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createHierarchyScope(org.eclipse.wst.jsdt.core.IType, org.eclipse.wst.jsdt.core.WorkingCopyOwner)"><!-- --></A><H3> |
| createHierarchyScope</H3> |
| <PRE> |
| public static <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchScope.html" title="interface in org.eclipse.wst.jsdt.core.search">IJavaScriptSearchScope</A> <B>createHierarchyScope</B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IType.html" title="interface in org.eclipse.wst.jsdt.core">IType</A> type, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/WorkingCopyOwner.html" title="class in org.eclipse.wst.jsdt.core">WorkingCopyOwner</A> owner) |
| throws <A HREF="../../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Returns a JavaScript search scope limited to the hierarchy of the given type. |
| When the hierarchy is computed, the types defined in the working copies owned |
| by the given owner take precedence over the original javascript unit s. |
| The JavaScript elements resulting from a search with this scope will |
| be types in this hierarchy, or members of the types in this hierarchy. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>type</CODE> - the focus of the hierarchy scope<DD><CODE>owner</CODE> - the owner of working copies that take precedence over original javascript unit s |
| <DT><B>Returns:</B><DD>a new hierarchy scope |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if the hierarchy could not be computed on the given type</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createJavaSearchScope(org.eclipse.wst.jsdt.core.IJavaScriptElement[])"><!-- --></A><H3> |
| createJavaSearchScope</H3> |
| <PRE> |
| public static <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchScope.html" title="interface in org.eclipse.wst.jsdt.core.search">IJavaScriptSearchScope</A> <B>createJavaSearchScope</B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A>[] elements)</PRE> |
| <DL> |
| <DD>Returns a JavaScript search scope limited to the given JavaScript elements. |
| The JavaScript elements resulting from a search with this scope will |
| be children of the given elements. |
| <p> |
| If an element is an IJavaScriptProject, then the project's source folders, |
| its jars (external and internal) and its referenced projects (with their source |
| folders and jars, recursively) will be included. |
| If an element is an IPackageFragmentRoot, then only the package fragments of |
| this package fragment root will be included. |
| If an element is an IPackageFragment, then only the javascript unit and class |
| files of this package fragment will be included. Subpackages will NOT be |
| included.</p> |
| <p> |
| In other words, this is equivalent to using SearchEngine.createJavaSearchScope(elements, true).</p> |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>elements</CODE> - the JavaScript elements the scope is limited to |
| <DT><B>Returns:</B><DD>a new JavaScript search scope</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createJavaSearchScope(org.eclipse.wst.jsdt.core.IJavaScriptElement[], boolean)"><!-- --></A><H3> |
| createJavaSearchScope</H3> |
| <PRE> |
| public static <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchScope.html" title="interface in org.eclipse.wst.jsdt.core.search">IJavaScriptSearchScope</A> <B>createJavaSearchScope</B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A>[] elements, |
| boolean includeReferencedProjects)</PRE> |
| <DL> |
| <DD>Returns a JavaScript search scope limited to the given JavaScript elements. |
| The JavaScript elements resulting from a search with this scope will |
| be children of the given elements. |
| |
| If an element is an IJavaScriptProject, then the project's source folders, |
| its jars (external and internal) and - if specified - its referenced projects |
| (with their source folders and jars, recursively) will be included. |
| If an element is an IPackageFragmentRoot, then only the package fragments of |
| this package fragment root will be included. |
| If an element is an IPackageFragment, then only the javascript unit and class |
| files of this package fragment will be included. Subpackages will NOT be |
| included. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>elements</CODE> - the JavaScript elements the scope is limited to<DD><CODE>includeReferencedProjects</CODE> - a flag indicating if referenced projects must be |
| recursively included |
| <DT><B>Returns:</B><DD>a new JavaScript search scope</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createJavaSearchScope(org.eclipse.wst.jsdt.core.IJavaScriptElement[], int)"><!-- --></A><H3> |
| createJavaSearchScope</H3> |
| <PRE> |
| public static <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchScope.html" title="interface in org.eclipse.wst.jsdt.core.search">IJavaScriptSearchScope</A> <B>createJavaSearchScope</B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A>[] elements, |
| int includeMask)</PRE> |
| <DL> |
| <DD>Returns a JavaScript search scope limited to the given JavaScript elements. |
| The JavaScript elements resulting from a search with this scope will |
| be children of the given elements. |
| |
| If an element is an IJavaScriptProject, then it includes: |
| - its source folders if IJavaScriptSearchScope.SOURCES is specified, |
| - its application libraries (internal and external jars, class folders that are on the raw includepath, |
| or the ones that are coming from a includepath path variable, |
| or the ones that are coming from a includepath container with the K_APPLICATION kind) |
| if IJavaScriptSearchScope.APPLICATION_LIBRARIES is specified |
| - its system libraries (internal and external jars, class folders that are coming from an |
| IJsGlobalScopeContainer with the K_SYSTEM kind) |
| if IJavaScriptSearchScope.APPLICATION_LIBRARIES is specified |
| - its referenced projects (with their source folders and jars, recursively) |
| if IJavaScriptSearchScope.REFERENCED_PROJECTS is specified. |
| If an element is an IPackageFragmentRoot, then only the package fragments of |
| this package fragment root will be included. |
| If an element is an IPackageFragment, then only the javascript unit and class |
| files of this package fragment will be included. Subpackages will NOT be |
| included. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>elements</CODE> - the JavaScript elements the scope is limited to<DD><CODE>includeMask</CODE> - the bit-wise OR of all include types of interest |
| <DT><B>Returns:</B><DD>a new JavaScript search scope<DT><B>See Also:</B><DD><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchScope.html#SOURCES"><CODE>IJavaScriptSearchScope.SOURCES</CODE></A>, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchScope.html#APPLICATION_LIBRARIES"><CODE>IJavaScriptSearchScope.APPLICATION_LIBRARIES</CODE></A>, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchScope.html#SYSTEM_LIBRARIES"><CODE>IJavaScriptSearchScope.SYSTEM_LIBRARIES</CODE></A>, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchScope.html#REFERENCED_PROJECTS"><CODE>IJavaScriptSearchScope.REFERENCED_PROJECTS</CODE></A></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createTypeNameMatch(org.eclipse.wst.jsdt.core.IType, int)"><!-- --></A><H3> |
| createTypeNameMatch</H3> |
| <PRE> |
| public static <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/TypeNameMatch.html" title="class in org.eclipse.wst.jsdt.core.search">TypeNameMatch</A> <B>createTypeNameMatch</B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IType.html" title="interface in org.eclipse.wst.jsdt.core">IType</A> type, |
| int modifiers)</PRE> |
| <DL> |
| <DD>Create a type name match on a given type with specific modifiers. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>type</CODE> - The javascript model handle of the type<DD><CODE>modifiers</CODE> - Modifiers of the type |
| <DT><B>Returns:</B><DD>A non-null match on the given type.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="createWorkspaceScope()"><!-- --></A><H3> |
| createWorkspaceScope</H3> |
| <PRE> |
| public static <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchScope.html" title="interface in org.eclipse.wst.jsdt.core.search">IJavaScriptSearchScope</A> <B>createWorkspaceScope</B>()</PRE> |
| <DL> |
| <DD>Returns a JavaScript search scope with the workspace as the only limit. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>a new workspace scope</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getDefaultSearchParticipant()"><!-- --></A><H3> |
| getDefaultSearchParticipant</H3> |
| <PRE> |
| public static <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchParticipant.html" title="class in org.eclipse.wst.jsdt.core.search">SearchParticipant</A> <B>getDefaultSearchParticipant</B>()</PRE> |
| <DL> |
| <DD>Returns a new default JavaScript search participant. |
| <P> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>a new default JavaScript search participant</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="search(org.eclipse.wst.jsdt.core.search.SearchPattern, org.eclipse.wst.jsdt.core.search.SearchParticipant[], org.eclipse.wst.jsdt.core.search.IJavaScriptSearchScope, org.eclipse.wst.jsdt.core.search.SearchRequestor, IProgressMonitor)"><!-- --></A><H3> |
| search</H3> |
| <PRE> |
| public void <B>search</B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html" title="class in org.eclipse.wst.jsdt.core.search">SearchPattern</A> pattern, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchParticipant.html" title="class in org.eclipse.wst.jsdt.core.search">SearchParticipant</A>[] participants, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchScope.html" title="interface in org.eclipse.wst.jsdt.core.search">IJavaScriptSearchScope</A> scope, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchRequestor.html" title="class in org.eclipse.wst.jsdt.core.search">SearchRequestor</A> requestor, |
| IProgressMonitor monitor) |
| throws CoreException</PRE> |
| <DL> |
| <DD>Searches for matches of a given search pattern. Search patterns can be created using helper |
| methods (from a String pattern or a JavaScript element) and encapsulate the description of what is |
| being searched (for example, search method declarations in a case sensitive way). |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>pattern</CODE> - the pattern to search<DD><CODE>participants</CODE> - the particpants in the search<DD><CODE>scope</CODE> - the search scope<DD><CODE>requestor</CODE> - the requestor to report the matches to<DD><CODE>monitor</CODE> - the progress monitor used to report progress |
| <DT><B>Throws:</B> |
| <DD><CODE>CoreException</CODE> - if the search failed. Reasons include: |
| <ul> |
| <li>the includepath is incorrectly set</li> |
| </ul></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="searchAllTypeNames(char[], int, char[], int, int, org.eclipse.wst.jsdt.core.search.IJavaScriptSearchScope, org.eclipse.wst.jsdt.core.search.TypeNameRequestor, int, IProgressMonitor)"><!-- --></A><H3> |
| searchAllTypeNames</H3> |
| <PRE> |
| public void <B>searchAllTypeNames</B>(char[] packageName, |
| int packageMatchRule, |
| char[] typeName, |
| int typeMatchRule, |
| int searchFor, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchScope.html" title="interface in org.eclipse.wst.jsdt.core.search">IJavaScriptSearchScope</A> scope, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/TypeNameRequestor.html" title="class in org.eclipse.wst.jsdt.core.search">TypeNameRequestor</A> nameRequestor, |
| int waitingPolicy, |
| IProgressMonitor progressMonitor) |
| throws <A HREF="../../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Searches for all top-level types and member types in the given scope. |
| The search can be selecting specific types (given a package name using specific match mode |
| and/or a type name using another specific match mode). |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>packageName</CODE> - the full name of the package of the searched types, or a prefix for this |
| package, or a wild-carded string for this package. |
| May be <code>null</code>, then any package name is accepted.<DD><CODE>typeName</CODE> - the dot-separated qualified name of the searched type (the qualification include |
| the enclosing types if the searched type is a member type), or a prefix |
| for this type, or a wild-carded string for this type. |
| May be <code>null</code>, then any type name is accepted.<DD><CODE>packageMatchRule</CODE> - one of |
| <ul> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#R_EXACT_MATCH"><CODE>SearchPattern.R_EXACT_MATCH</CODE></A> if the package name and type name are the full names |
| of the searched types.</li> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#R_PREFIX_MATCH"><CODE>SearchPattern.R_PREFIX_MATCH</CODE></A> if the package name and type name are prefixes of the names |
| of the searched types.</li> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#R_PATTERN_MATCH"><CODE>SearchPattern.R_PATTERN_MATCH</CODE></A> if the package name and type name contain wild-cards.</li> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#R_CAMELCASE_MATCH"><CODE>SearchPattern.R_CAMELCASE_MATCH</CODE></A> if type name are camel case of the names of the searched types.</li> |
| </ul> |
| combined with <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#R_CASE_SENSITIVE"><CODE>SearchPattern.R_CASE_SENSITIVE</CODE></A>, |
| e.g. <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#R_EXACT_MATCH"><CODE>SearchPattern.R_EXACT_MATCH</CODE></A> | <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#R_CASE_SENSITIVE"><CODE>SearchPattern.R_CASE_SENSITIVE</CODE></A> if an exact and case sensitive match is requested, |
| or <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#R_PREFIX_MATCH"><CODE>SearchPattern.R_PREFIX_MATCH</CODE></A> if a prefix non case sensitive match is requested.<DD><CODE>typeMatchRule</CODE> - one of |
| <ul> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#R_EXACT_MATCH"><CODE>SearchPattern.R_EXACT_MATCH</CODE></A> if the package name and type name are the full names |
| of the searched types.</li> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#R_PREFIX_MATCH"><CODE>SearchPattern.R_PREFIX_MATCH</CODE></A> if the package name and type name are prefixes of the names |
| of the searched types.</li> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#R_PATTERN_MATCH"><CODE>SearchPattern.R_PATTERN_MATCH</CODE></A> if the package name and type name contain wild-cards.</li> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#R_CAMELCASE_MATCH"><CODE>SearchPattern.R_CAMELCASE_MATCH</CODE></A> if type name are camel case of the names of the searched types.</li> |
| </ul> |
| combined with <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#R_CASE_SENSITIVE"><CODE>SearchPattern.R_CASE_SENSITIVE</CODE></A>, |
| e.g. <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#R_EXACT_MATCH"><CODE>SearchPattern.R_EXACT_MATCH</CODE></A> | <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#R_CASE_SENSITIVE"><CODE>SearchPattern.R_CASE_SENSITIVE</CODE></A> if an exact and case sensitive match is requested, |
| or <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#R_PREFIX_MATCH"><CODE>SearchPattern.R_PREFIX_MATCH</CODE></A> if a prefix non case sensitive match is requested.<DD><CODE>searchFor</CODE> - determines the nature of the searched elements |
| <ul> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchConstants.html#CLASS"><CODE>IJavaScriptSearchConstants.CLASS</CODE></A>: only look for classes</li> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchConstants.html#INTERFACE"><CODE>IJavaScriptSearchConstants.INTERFACE</CODE></A>: only look for interfaces</li> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchConstants.html#ENUM"><CODE>IJavaScriptSearchConstants.ENUM</CODE></A>: only look for enumeration</li> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchConstants.html#ANNOTATION_TYPE"><CODE>IJavaScriptSearchConstants.ANNOTATION_TYPE</CODE></A>: only look for annotation type</li> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchConstants.html#CLASS_AND_ENUM"><CODE>IJavaScriptSearchConstants.CLASS_AND_ENUM</CODE></A>: only look for classes and enumerations</li> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchConstants.html#CLASS_AND_INTERFACE"><CODE>IJavaScriptSearchConstants.CLASS_AND_INTERFACE</CODE></A>: only look for classes and interfaces</li> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchConstants.html#TYPE"><CODE>IJavaScriptSearchConstants.TYPE</CODE></A>: look for all types (ie. classes, interfaces, enum and annotation types)</li> |
| </ul><DD><CODE>scope</CODE> - the scope to search in<DD><CODE>nameRequestor</CODE> - the requestor that collects the results of the search<DD><CODE>waitingPolicy</CODE> - one of |
| <ul> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchConstants.html#FORCE_IMMEDIATE_SEARCH"><CODE>IJavaScriptSearchConstants.FORCE_IMMEDIATE_SEARCH</CODE></A> if the search should start immediately</li> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchConstants.html#CANCEL_IF_NOT_READY_TO_SEARCH"><CODE>IJavaScriptSearchConstants.CANCEL_IF_NOT_READY_TO_SEARCH</CODE></A> if the search should be cancelled if the |
| underlying indexer has not finished indexing the workspace</li> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchConstants.html#WAIT_UNTIL_READY_TO_SEARCH"><CODE>IJavaScriptSearchConstants.WAIT_UNTIL_READY_TO_SEARCH</CODE></A> if the search should wait for the |
| underlying indexer to finish indexing the workspace</li> |
| </ul><DD><CODE>progressMonitor</CODE> - the progress monitor to report progress to, or <code>null</code> if no progress |
| monitor is provided |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if the search failed. Reasons include: |
| <ul> |
| <li>the includepath is incorrectly set</li> |
| </ul></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="searchAllTypeNames(char[], int, char[], int, int, org.eclipse.wst.jsdt.core.search.IJavaScriptSearchScope, org.eclipse.wst.jsdt.core.search.TypeNameMatchRequestor, int, IProgressMonitor)"><!-- --></A><H3> |
| searchAllTypeNames</H3> |
| <PRE> |
| public void <B>searchAllTypeNames</B>(char[] packageName, |
| int packageMatchRule, |
| char[] typeName, |
| int typeMatchRule, |
| int searchFor, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchScope.html" title="interface in org.eclipse.wst.jsdt.core.search">IJavaScriptSearchScope</A> scope, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/TypeNameMatchRequestor.html" title="class in org.eclipse.wst.jsdt.core.search">TypeNameMatchRequestor</A> nameMatchRequestor, |
| int waitingPolicy, |
| IProgressMonitor progressMonitor) |
| throws <A HREF="../../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Searches for all top-level types and member types in the given scope. |
| The search can be selecting specific types (given a package name using specific match mode |
| and/or a type name using another specific match mode). |
| <p> |
| Provided <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/TypeNameMatchRequestor.html" title="class in org.eclipse.wst.jsdt.core.search"><CODE>TypeNameMatchRequestor</CODE></A> requestor will collect <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/TypeNameMatch.html" title="class in org.eclipse.wst.jsdt.core.search"><CODE>TypeNameMatch</CODE></A> |
| matches found during the search. |
| </p> |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>packageName</CODE> - the full name of the package of the searched types, or a prefix for this |
| package, or a wild-carded string for this package. |
| May be <code>null</code>, then any package name is accepted.<DD><CODE>packageMatchRule</CODE> - one of |
| <ul> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#R_EXACT_MATCH"><CODE>SearchPattern.R_EXACT_MATCH</CODE></A> if the package name and type name are the full names |
| of the searched types.</li> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#R_PREFIX_MATCH"><CODE>SearchPattern.R_PREFIX_MATCH</CODE></A> if the package name and type name are prefixes of the names |
| of the searched types.</li> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#R_PATTERN_MATCH"><CODE>SearchPattern.R_PATTERN_MATCH</CODE></A> if the package name and type name contain wild-cards.</li> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#R_CAMELCASE_MATCH"><CODE>SearchPattern.R_CAMELCASE_MATCH</CODE></A> if type name are camel case of the names of the searched types.</li> |
| </ul> |
| combined with <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#R_CASE_SENSITIVE"><CODE>SearchPattern.R_CASE_SENSITIVE</CODE></A>, |
| e.g. <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#R_EXACT_MATCH"><CODE>SearchPattern.R_EXACT_MATCH</CODE></A> | <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#R_CASE_SENSITIVE"><CODE>SearchPattern.R_CASE_SENSITIVE</CODE></A> if an exact and case sensitive match is requested, |
| or <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#R_PREFIX_MATCH"><CODE>SearchPattern.R_PREFIX_MATCH</CODE></A> if a prefix non case sensitive match is requested.<DD><CODE>typeName</CODE> - the dot-separated qualified name of the searched type (the qualification include |
| the enclosing types if the searched type is a member type), or a prefix |
| for this type, or a wild-carded string for this type. |
| May be <code>null</code>, then any type name is accepted.<DD><CODE>typeMatchRule</CODE> - one of |
| <ul> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#R_EXACT_MATCH"><CODE>SearchPattern.R_EXACT_MATCH</CODE></A> if the package name and type name are the full names |
| of the searched types.</li> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#R_PREFIX_MATCH"><CODE>SearchPattern.R_PREFIX_MATCH</CODE></A> if the package name and type name are prefixes of the names |
| of the searched types.</li> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#R_PATTERN_MATCH"><CODE>SearchPattern.R_PATTERN_MATCH</CODE></A> if the package name and type name contain wild-cards.</li> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#R_CAMELCASE_MATCH"><CODE>SearchPattern.R_CAMELCASE_MATCH</CODE></A> if type name are camel case of the names of the searched types.</li> |
| </ul> |
| combined with <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#R_CASE_SENSITIVE"><CODE>SearchPattern.R_CASE_SENSITIVE</CODE></A>, |
| e.g. <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#R_EXACT_MATCH"><CODE>SearchPattern.R_EXACT_MATCH</CODE></A> | <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#R_CASE_SENSITIVE"><CODE>SearchPattern.R_CASE_SENSITIVE</CODE></A> if an exact and case sensitive match is requested, |
| or <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchPattern.html#R_PREFIX_MATCH"><CODE>SearchPattern.R_PREFIX_MATCH</CODE></A> if a prefix non case sensitive match is requested.<DD><CODE>searchFor</CODE> - determines the nature of the searched elements |
| <ul> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchConstants.html#CLASS"><CODE>IJavaScriptSearchConstants.CLASS</CODE></A>: only look for classes</li> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchConstants.html#INTERFACE"><CODE>IJavaScriptSearchConstants.INTERFACE</CODE></A>: only look for interfaces</li> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchConstants.html#ENUM"><CODE>IJavaScriptSearchConstants.ENUM</CODE></A>: only look for enumeration</li> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchConstants.html#ANNOTATION_TYPE"><CODE>IJavaScriptSearchConstants.ANNOTATION_TYPE</CODE></A>: only look for annotation type</li> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchConstants.html#CLASS_AND_ENUM"><CODE>IJavaScriptSearchConstants.CLASS_AND_ENUM</CODE></A>: only look for classes and enumerations</li> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchConstants.html#CLASS_AND_INTERFACE"><CODE>IJavaScriptSearchConstants.CLASS_AND_INTERFACE</CODE></A>: only look for classes and interfaces</li> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchConstants.html#TYPE"><CODE>IJavaScriptSearchConstants.TYPE</CODE></A>: look for all types (ie. classes, interfaces, enum and annotation types)</li> |
| </ul><DD><CODE>scope</CODE> - the scope to search in<DD><CODE>nameMatchRequestor</CODE> - the <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/TypeNameMatchRequestor.html" title="class in org.eclipse.wst.jsdt.core.search"><CODE>requestor</CODE></A> that collects |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/TypeNameMatch.html" title="class in org.eclipse.wst.jsdt.core.search"><CODE>matches</CODE></A> of the search.<DD><CODE>waitingPolicy</CODE> - one of |
| <ul> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchConstants.html#FORCE_IMMEDIATE_SEARCH"><CODE>IJavaScriptSearchConstants.FORCE_IMMEDIATE_SEARCH</CODE></A> if the search should start immediately</li> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchConstants.html#CANCEL_IF_NOT_READY_TO_SEARCH"><CODE>IJavaScriptSearchConstants.CANCEL_IF_NOT_READY_TO_SEARCH</CODE></A> if the search should be cancelled if the |
| underlying indexer has not finished indexing the workspace</li> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchConstants.html#WAIT_UNTIL_READY_TO_SEARCH"><CODE>IJavaScriptSearchConstants.WAIT_UNTIL_READY_TO_SEARCH</CODE></A> if the search should wait for the |
| underlying indexer to finish indexing the workspace</li> |
| </ul><DD><CODE>progressMonitor</CODE> - the progress monitor to report progress to, or <code>null</code> if no progress |
| monitor is provided |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if the search failed. Reasons include: |
| <ul> |
| <li>the includepath is incorrectly set</li> |
| </ul></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="searchAllTypeNames(char[][], char[][], org.eclipse.wst.jsdt.core.search.IJavaScriptSearchScope, org.eclipse.wst.jsdt.core.search.TypeNameRequestor, int, IProgressMonitor)"><!-- --></A><H3> |
| searchAllTypeNames</H3> |
| <PRE> |
| public void <B>searchAllTypeNames</B>(char[][] qualifications, |
| char[][] typeNames, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchScope.html" title="interface in org.eclipse.wst.jsdt.core.search">IJavaScriptSearchScope</A> scope, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/TypeNameRequestor.html" title="class in org.eclipse.wst.jsdt.core.search">TypeNameRequestor</A> nameRequestor, |
| int waitingPolicy, |
| IProgressMonitor progressMonitor) |
| throws <A HREF="../../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Searches for all top-level types and member types in the given scope matching any of the given qualifications |
| and type names in a case sensitive way. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>qualifications</CODE> - the qualified name of the package/enclosing type of the searched types. |
| May be <code>null</code>, then any package name is accepted.<DD><CODE>typeNames</CODE> - the simple names of the searched types. |
| If this parameter is <code>null</code>, then no type will be found.<DD><CODE>scope</CODE> - the scope to search in<DD><CODE>nameRequestor</CODE> - the requestor that collects the results of the search<DD><CODE>waitingPolicy</CODE> - one of |
| <ul> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchConstants.html#FORCE_IMMEDIATE_SEARCH"><CODE>IJavaScriptSearchConstants.FORCE_IMMEDIATE_SEARCH</CODE></A> if the search should start immediately</li> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchConstants.html#CANCEL_IF_NOT_READY_TO_SEARCH"><CODE>IJavaScriptSearchConstants.CANCEL_IF_NOT_READY_TO_SEARCH</CODE></A> if the search should be cancelled if the |
| underlying indexer has not finished indexing the workspace</li> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchConstants.html#WAIT_UNTIL_READY_TO_SEARCH"><CODE>IJavaScriptSearchConstants.WAIT_UNTIL_READY_TO_SEARCH</CODE></A> if the search should wait for the |
| underlying indexer to finish indexing the workspace</li> |
| </ul><DD><CODE>progressMonitor</CODE> - the progress monitor to report progress to, or <code>null</code> if no progress |
| monitor is provided |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if the search failed. Reasons include: |
| <ul> |
| <li>the includepath is incorrectly set</li> |
| </ul></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="searchAllTypeNames(char[][], char[][], org.eclipse.wst.jsdt.core.search.IJavaScriptSearchScope, org.eclipse.wst.jsdt.core.search.TypeNameMatchRequestor, int, IProgressMonitor)"><!-- --></A><H3> |
| searchAllTypeNames</H3> |
| <PRE> |
| public void <B>searchAllTypeNames</B>(char[][] qualifications, |
| char[][] typeNames, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchScope.html" title="interface in org.eclipse.wst.jsdt.core.search">IJavaScriptSearchScope</A> scope, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/TypeNameMatchRequestor.html" title="class in org.eclipse.wst.jsdt.core.search">TypeNameMatchRequestor</A> nameMatchRequestor, |
| int waitingPolicy, |
| IProgressMonitor progressMonitor) |
| throws <A HREF="../../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Searches for all top-level types and member types in the given scope matching any of the given qualifications |
| and type names in a case sensitive way. |
| <p> |
| Provided <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/TypeNameMatchRequestor.html" title="class in org.eclipse.wst.jsdt.core.search"><CODE>TypeNameMatchRequestor</CODE></A> requestor will collect <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/TypeNameMatch.html" title="class in org.eclipse.wst.jsdt.core.search"><CODE>TypeNameMatch</CODE></A> |
| matches found during the search. |
| </p> |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>qualifications</CODE> - the qualified name of the package/enclosing type of the searched types. |
| May be <code>null</code>, then any package name is accepted.<DD><CODE>typeNames</CODE> - the simple names of the searched types. |
| If this parameter is <code>null</code>, then no type will be found.<DD><CODE>scope</CODE> - the scope to search in<DD><CODE>nameMatchRequestor</CODE> - the <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/TypeNameMatchRequestor.html" title="class in org.eclipse.wst.jsdt.core.search"><CODE>requestor</CODE></A> that collects |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/TypeNameMatch.html" title="class in org.eclipse.wst.jsdt.core.search"><CODE>matches</CODE></A> of the search.<DD><CODE>waitingPolicy</CODE> - one of |
| <ul> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchConstants.html#FORCE_IMMEDIATE_SEARCH"><CODE>IJavaScriptSearchConstants.FORCE_IMMEDIATE_SEARCH</CODE></A> if the search should start immediately</li> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchConstants.html#CANCEL_IF_NOT_READY_TO_SEARCH"><CODE>IJavaScriptSearchConstants.CANCEL_IF_NOT_READY_TO_SEARCH</CODE></A> if the search should be cancelled if the |
| underlying indexer has not finished indexing the workspace</li> |
| <li><A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/IJavaScriptSearchConstants.html#WAIT_UNTIL_READY_TO_SEARCH"><CODE>IJavaScriptSearchConstants.WAIT_UNTIL_READY_TO_SEARCH</CODE></A> if the search should wait for the |
| underlying indexer to finish indexing the workspace</li> |
| </ul><DD><CODE>progressMonitor</CODE> - the progress monitor to report progress to, or <code>null</code> if no progress |
| monitor is provided |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if the search failed. Reasons include: |
| <ul> |
| <li>the includepath is incorrectly set</li> |
| </ul></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="searchDeclarationsOfAccessedFields(org.eclipse.wst.jsdt.core.IJavaScriptElement, org.eclipse.wst.jsdt.core.search.SearchRequestor, IProgressMonitor)"><!-- --></A><H3> |
| searchDeclarationsOfAccessedFields</H3> |
| <PRE> |
| public void <B>searchDeclarationsOfAccessedFields</B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A> enclosingElement, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchRequestor.html" title="class in org.eclipse.wst.jsdt.core.search">SearchRequestor</A> requestor, |
| IProgressMonitor monitor) |
| throws <A HREF="../../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Searches for all declarations of the fields accessed in the given element. |
| The element can be a javascript unit , a source type, or a source method. |
| Reports the field declarations using the given requestor. |
| <p> |
| Consider the following code: |
| <code> |
| <pre> |
| class A { |
| int field1; |
| } |
| class B extends A { |
| String value; |
| } |
| class X { |
| void test() { |
| B b = new B(); |
| System.out.println(b.value + b.field1); |
| }; |
| } |
| </pre> |
| </code> |
| then searching for declarations of accessed fields in method |
| <code>X.test()</code> would collect the fields |
| <code>B.value</code> and <code>A.field1</code>. |
| </p> |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>enclosingElement</CODE> - the method, type, or javascript unit to be searched in<DD><CODE>requestor</CODE> - a callback object to which each match is reported<DD><CODE>monitor</CODE> - the progress monitor used to report progress |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if the search failed. Reasons include: |
| <ul> |
| <li>the element doesn't exist</li> |
| <li>the includepath is incorrectly set</li> |
| </ul></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="searchDeclarationsOfReferencedTypes(org.eclipse.wst.jsdt.core.IJavaScriptElement, org.eclipse.wst.jsdt.core.search.SearchRequestor, IProgressMonitor)"><!-- --></A><H3> |
| searchDeclarationsOfReferencedTypes</H3> |
| <PRE> |
| public void <B>searchDeclarationsOfReferencedTypes</B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A> enclosingElement, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchRequestor.html" title="class in org.eclipse.wst.jsdt.core.search">SearchRequestor</A> requestor, |
| IProgressMonitor monitor) |
| throws <A HREF="../../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Searches for all declarations of the types referenced in the given element. |
| The element can be a javascript unit , a source type, or a source method. |
| Reports the type declarations using the given requestor. |
| <p> |
| Consider the following code: |
| <code> |
| <pre> |
| class A { |
| } |
| class B extends A { |
| } |
| interface I { |
| int VALUE = 0; |
| } |
| class X { |
| void test() { |
| B b = new B(); |
| this.foo(b, I.VALUE); |
| }; |
| } |
| </pre> |
| </code> |
| then searching for declarations of referenced types in method <code>X.test()</code> |
| would collect the class <code>B</code> and the interface <code>I</code>. |
| </p> |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>enclosingElement</CODE> - the method, type, or javascript unit to be searched in<DD><CODE>requestor</CODE> - a callback object to which each match is reported<DD><CODE>monitor</CODE> - the progress monitor used to report progress |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if the search failed. Reasons include: |
| <ul> |
| <li>the element doesn't exist</li> |
| <li>the includepath is incorrectly set</li> |
| </ul></DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="searchDeclarationsOfSentMessages(org.eclipse.wst.jsdt.core.IJavaScriptElement, org.eclipse.wst.jsdt.core.search.SearchRequestor, IProgressMonitor)"><!-- --></A><H3> |
| searchDeclarationsOfSentMessages</H3> |
| <PRE> |
| public void <B>searchDeclarationsOfSentMessages</B>(<A HREF="../../../../../../org/eclipse/wst/jsdt/core/IJavaScriptElement.html" title="interface in org.eclipse.wst.jsdt.core">IJavaScriptElement</A> enclosingElement, |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchRequestor.html" title="class in org.eclipse.wst.jsdt.core.search">SearchRequestor</A> requestor, |
| IProgressMonitor monitor) |
| throws <A HREF="../../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></PRE> |
| <DL> |
| <DD>Searches for all declarations of the methods invoked in the given element. |
| The element can be a javascript unit , a source type, or a source method. |
| Reports the method declarations using the given requestor. |
| <p> |
| Consider the following code: |
| <code> |
| <pre> |
| class A { |
| void foo() {}; |
| void bar() {}; |
| } |
| class B extends A { |
| void foo() {}; |
| } |
| class X { |
| void test() { |
| A a = new B(); |
| a.foo(); |
| B b = (B)a; |
| b.bar(); |
| }; |
| } |
| </pre> |
| </code> |
| then searching for declarations of sent messages in method |
| <code>X.test()</code> would collect the methods |
| <code>A.foo()</code>, <code>B.foo()</code>, and <code>A.bar()</code>. |
| </p> |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>enclosingElement</CODE> - the method, type, or javascript unit to be searched in<DD><CODE>requestor</CODE> - a callback object to which each match is reported<DD><CODE>monitor</CODE> - the progress monitor used to report progress |
| <DT><B>Throws:</B> |
| <DD><CODE><A HREF="../../../../../../org/eclipse/wst/jsdt/core/JavaScriptModelException.html" title="class in org.eclipse.wst.jsdt.core">JavaScriptModelException</A></CODE> - if the search failed. Reasons include: |
| <ul> |
| <li>the element doesn't exist</li> |
| <li>the includepath is incorrectly set</li> |
| </ul></DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/SearchEngine.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchDocument.html" title="class in org.eclipse.wst.jsdt.core.search"><B>PREV CLASS</B></A> |
| <A HREF="../../../../../../org/eclipse/wst/jsdt/core/search/SearchMatch.html" title="class in org.eclipse.wst.jsdt.core.search"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../index.html?org/eclipse/wst/jsdt/core/search/SearchEngine.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="SearchEngine.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| </BODY> |
| </HTML> |
