public abstract class TextSearchMatchAccess extends Object
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 TextSearchMatchAccess
TextSearchMatchAccess
element.
This class should only be implemented by implementors of a TextSearchEngine
.
Constructor and Description |
---|
TextSearchMatchAccess() |
Modifier and Type | Method and Description |
---|---|
abstract IFile |
getFile()
Returns the file the match was found in.
|
abstract String |
getFileContent(int offset,
int length)
Returns the file's content at the given offsets.
|
abstract char |
getFileContentChar(int offset)
Returns a character of the file's content at the given offset
|
abstract int |
getFileContentLength()
Returns the length of this file's content.
|
abstract int |
getMatchLength()
Returns the length of this search match.
|
abstract int |
getMatchOffset()
Returns the offset of this search match.
|
public abstract IFile getFile()
public abstract int getMatchOffset()
public abstract int getMatchLength()
public abstract int getFileContentLength()
public abstract char getFileContentChar(int offset)
offset
- the offsetIndexOutOfBoundsException
- an IndexOutOfBoundsException
is
thrown when the offset
is negative or not less than the file content's length.public abstract String getFileContent(int offset, int length)
offset
- the offset of the requested contentlength
- the of the requested contentIndexOutOfBoundsException
- an IndexOutOfBoundsException
is
thrown when the offset
or the length
are negative
or when offset + length
is not less than the file content's length.
Copyright (c) 2000, 2018 Eclipse Contributors and others. All rights reserved.Guidelines for using Eclipse APIs.