| <!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:06 CDT 2008 --> |
| <TITLE> |
| NullSearchDocument |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.eclipse.wst.jsdt.web.core.javascript.search.NullSearchDocument class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="NullSearchDocument"; |
| } |
| </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/NullSearchDocument.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/web/core/javascript/search/JsSearchSupport.html" title="class in org.eclipse.wst.jsdt.web.core.javascript.search"><B>PREV CLASS</B></A> |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../../../index.html?org/eclipse/wst/jsdt/web/core/javascript/search/NullSearchDocument.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="NullSearchDocument.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.web.core.javascript.search</FONT> |
| <BR> |
| Class NullSearchDocument</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../../../../../resources/inherit.gif" ALT="extended by ">org.eclipse.wst.jsdt.internal.core.search.indexing.InternalSearchDocument |
| <IMG SRC="../../../../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/SearchDocument.html" title="class in org.eclipse.wst.jsdt.core.search">org.eclipse.wst.jsdt.core.search.SearchDocument</A> |
| <IMG SRC="../../../../../../../../resources/inherit.gif" ALT="extended by "><B>org.eclipse.wst.jsdt.web.core.javascript.search.NullSearchDocument</B> |
| </PRE> |
| <HR> |
| <DL> |
| <DT><PRE>public class <B>NullSearchDocument</B><DT>extends <A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/SearchDocument.html" title="class in org.eclipse.wst.jsdt.core.search">SearchDocument</A></DL> |
| </PRE> |
| |
| <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. |
| |
| An empty servlet, safe for Java search participation |
| <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/web/core/javascript/search/NullSearchDocument.html#NullSearchDocument(java.lang.String)">NullSearchDocument</A></B>(java.lang.String documentPath)</CODE> |
| |
| <BR> |
| </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> byte[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../../org/eclipse/wst/jsdt/web/core/javascript/search/NullSearchDocument.html#getByteContents()">getByteContents</A></B>()</CODE> |
| |
| <BR> |
| Returns the contents of this document.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> char[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../../org/eclipse/wst/jsdt/web/core/javascript/search/NullSearchDocument.html#getCharContents()">getCharContents</A></B>()</CODE> |
| |
| <BR> |
| Returns the contents of this document.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../../../org/eclipse/wst/jsdt/web/core/javascript/search/NullSearchDocument.html#getEncoding()">getEncoding</A></B>()</CODE> |
| |
| <BR> |
| Returns the encoding for this document.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_org.eclipse.wst.jsdt.core.search.SearchDocument"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class org.eclipse.wst.jsdt.core.search.<A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/SearchDocument.html" title="class in org.eclipse.wst.jsdt.core.search">SearchDocument</A></B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/SearchDocument.html#addIndexEntry(char[], char[])">addIndexEntry</A>, <A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/SearchDocument.html#getJavaElement()">getJavaElement</A>, <A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/SearchDocument.html#getParticipant()">getParticipant</A>, <A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/SearchDocument.html#getPath()">getPath</A>, <A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/SearchDocument.html#isVirtual()">isVirtual</A>, <A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/SearchDocument.html#removeAllIndexEntries()">removeAllIndexEntries</A></CODE></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="NullSearchDocument(java.lang.String)"><!-- --></A><H3> |
| NullSearchDocument</H3> |
| <PRE> |
| public <B>NullSearchDocument</B>(java.lang.String documentPath)</PRE> |
| <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="getByteContents()"><!-- --></A><H3> |
| getByteContents</H3> |
| <PRE> |
| public byte[] <B>getByteContents</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/SearchDocument.html#getByteContents()">SearchDocument</A></CODE></B></DD> |
| <DD>Returns the contents of this document. |
| Contents may be different from actual resource at corresponding document path, |
| in case of preprocessing. |
| <p> |
| This method must be implemented in subclasses. |
| </p><p> |
| Note: some implementation may choose to cache the contents directly on the |
| document for performance reason. However, this could induce scalability issues due |
| to the fact that collections of documents are manipulated throughout the search |
| operation, and cached contents would then consume lots of memory until they are |
| all released at once in the end. |
| </p> |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/SearchDocument.html#getByteContents()">getByteContents</A></CODE> in class <CODE><A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/SearchDocument.html" title="class in org.eclipse.wst.jsdt.core.search">SearchDocument</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the contents of this document, |
| or <code>null</code> if none</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCharContents()"><!-- --></A><H3> |
| getCharContents</H3> |
| <PRE> |
| public char[] <B>getCharContents</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/SearchDocument.html#getCharContents()">SearchDocument</A></CODE></B></DD> |
| <DD>Returns the contents of this document. |
| Contents may be different from actual resource at corresponding document |
| path due to preprocessing. |
| <p> |
| This method must be implemented in subclasses. |
| </p><p> |
| Note: some implementation may choose to cache the contents directly on the |
| document for performance reason. However, this could induce scalability issues due |
| to the fact that collections of documents are manipulated throughout the search |
| operation, and cached contents would then consume lots of memory until they are |
| all released at once in the end. |
| </p> |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/SearchDocument.html#getCharContents()">getCharContents</A></CODE> in class <CODE><A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/SearchDocument.html" title="class in org.eclipse.wst.jsdt.core.search">SearchDocument</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the contents of this document, |
| or <code>null</code> if none</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getEncoding()"><!-- --></A><H3> |
| getEncoding</H3> |
| <PRE> |
| public java.lang.String <B>getEncoding</B>()</PRE> |
| <DL> |
| <DD><B>Description copied from class: <CODE><A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/SearchDocument.html#getEncoding()">SearchDocument</A></CODE></B></DD> |
| <DD>Returns the encoding for this document. |
| <p> |
| This method must be implemented in subclasses. |
| </p> |
| <P> |
| <DD><DL> |
| <DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/SearchDocument.html#getEncoding()">getEncoding</A></CODE> in class <CODE><A HREF="../../../../../../../../org/eclipse/wst/jsdt/core/search/SearchDocument.html" title="class in org.eclipse.wst.jsdt.core.search">SearchDocument</A></CODE></DL> |
| </DD> |
| <DD><DL> |
| |
| <DT><B>Returns:</B><DD>the encoding for this document, |
| or <code>null</code> if none</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/NullSearchDocument.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/web/core/javascript/search/JsSearchSupport.html" title="class in org.eclipse.wst.jsdt.web.core.javascript.search"><B>PREV CLASS</B></A> |
| NEXT CLASS</FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../../../index.html?org/eclipse/wst/jsdt/web/core/javascript/search/NullSearchDocument.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="NullSearchDocument.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> |
