Package org.eclipse.search.core.text
Class TextSearchMatchAccess
java.lang.Object
org.eclipse.search.core.text.TextSearchMatchAccess
A
TextSearchMatchAccess gives access to a pattern match found by the TextSearchEngine.
Please note that objects do not
have value semantic. The state of the object might change over
time especially since objects are reused for different call backs. Clients shall not keep a reference to
a TextSearchMatchAccessTextSearchMatchAccess element.
This class should only be implemented by implementors of a TextSearchEngine.
- Since:
- 3.2
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionabstract IFilegetFile()Returns the file the match was found in.abstract StringgetFileContent(int offset, int length) Returns the file's content at the given offsets.abstract chargetFileContentChar(int offset) Returns a character of the file's content at the given offsetabstract intReturns the length of this file's content.abstract intReturns the length of this search match.abstract intReturns the offset of this search match.
-
Constructor Details
-
TextSearchMatchAccess
public TextSearchMatchAccess()
-
-
Method Details
-
getFile
Returns the file the match was found in.- Returns:
- the file the match was found.
-
getMatchOffset
public abstract int getMatchOffset()Returns the offset of this search match.- Returns:
- the offset of this search match
-
getMatchLength
public abstract int getMatchLength()Returns the length of this search match.- Returns:
- the length of this search match
-
getFileContentLength
public abstract int getFileContentLength()Returns the length of this file's content.- Returns:
- the length of this file's content.
-
getFileContentChar
public abstract char getFileContentChar(int offset) Returns a character of the file's content at the given offset- Parameters:
offset- the offset- Returns:
- the character at the given offset
- Throws:
IndexOutOfBoundsException- anIndexOutOfBoundsExceptionis thrown when theoffsetis negative or not less than the file content's length.
-
getFileContent
Returns the file's content at the given offsets.- Parameters:
offset- the offset of the requested contentlength- the of the requested content- Returns:
- the substring of the file's content
- Throws:
IndexOutOfBoundsException- anIndexOutOfBoundsExceptionis thrown when theoffsetor thelengthare negative or whenoffset + lengthis not less than the file content's length.
-