Class JavaSearchDocument
- Direct Known Subclasses:
MatchLocator.WorkingCopyDocument
-
Field Summary
-
Constructor Summary
ConstructorDescriptionJavaSearchDocument(String documentPath, byte[] contents, SearchParticipant participant)
JavaSearchDocument(String documentPath, SearchParticipant participant)
JavaSearchDocument(ZipEntry zipEntry, org.eclipse.core.runtime.IPath zipFilePath, byte[] contents, SearchParticipant participant)
-
Method Summary
Modifier and TypeMethodDescriptionbyte[]
Returns the contents of this document.char[]
Returns the contents of this document.Returns the encoding for this document.toString()
Methods inherited from class org.aspectj.org.eclipse.jdt.core.search.SearchDocument
addIndexEntry, getParser, getParticipant, getPath, removeAllIndexEntries, requireIndexingResolvedDocument, setIndex, setParser, shouldIndexResolvedDocument
-
Field Details
-
byteContents
protected byte[] byteContents -
charContents
protected char[] charContents
-
-
Constructor Details
-
JavaSearchDocument
-
JavaSearchDocument
public JavaSearchDocument(ZipEntry zipEntry, org.eclipse.core.runtime.IPath zipFilePath, byte[] contents, SearchParticipant participant) -
JavaSearchDocument
-
-
Method Details
-
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 classSearchDocument
- 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 classSearchDocument
- Returns:
- the contents of this document,
or
null
if none
-
getEncoding
Description copied from class:SearchDocument
Returns the encoding for this document.This method must be implemented in subclasses.
- Specified by:
getEncoding
in classSearchDocument
- Returns:
- the encoding for this document,
or
null
if none
-
toString
-