org.eclipse.wst.jsdt.web.core.javascript.search
Class NullSearchDocument

java.lang.Object
  extended by org.eclipse.wst.jsdt.internal.core.search.indexing.InternalSearchDocument
      extended by org.eclipse.wst.jsdt.core.search.SearchDocument
          extended by org.eclipse.wst.jsdt.web.core.javascript.search.NullSearchDocument

public class NullSearchDocument
extends SearchDocument

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


Constructor Summary
NullSearchDocument(java.lang.String documentPath)
           
 
Method Summary
 byte[] getByteContents()
          Returns the contents of this document.
 char[] getCharContents()
          Returns the contents of this document.
 java.lang.String getEncoding()
          Returns the encoding for this document.
 
Methods inherited from class org.eclipse.wst.jsdt.core.search.SearchDocument
addIndexEntry, getJavaElement, getParticipant, getPath, isVirtual, removeAllIndexEntries
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NullSearchDocument

public NullSearchDocument(java.lang.String documentPath)
Method Detail

getByteContents

public byte[] getByteContents()
Description copied from class: SearchDocument
Returns the contents of this document. Contents may be different from actual resource at corresponding document path, in case of preprocessing.

This method must be implemented in subclasses.

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.

Specified by:
getByteContents in class SearchDocument
Returns:
the contents of this document, or null if none

getCharContents

public char[] getCharContents()
Description copied from class: SearchDocument
Returns the contents of this document. Contents may be different from actual resource at corresponding document path due to preprocessing.

This method must be implemented in subclasses.

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.

Specified by:
getCharContents in class SearchDocument
Returns:
the contents of this document, or null if none

getEncoding

public java.lang.String getEncoding()
Description copied from class: SearchDocument
Returns the encoding for this document.

This method must be implemented in subclasses.

Specified by:
getEncoding in class SearchDocument
Returns:
the encoding for this document, or null if none