Package org.eclipse.search.ui.text
Interface IFileMatchAdapter
-
public interface IFileMatchAdapter
This interface serves to map matches toIFile
instances. Changes to those files are then tracked (via the platforms file buffer mechanism) and matches updated when changes are saved. Clients who want their match positions automatically updated should return an implementation ofIFileMatchAdapter
from thegetFileMatchAdapter()
method in their search result implementation. It is assumed that the match adapters are stateless, and no lifecycle management is provided.Clients may implement this interface.
- Since:
- 3.0
- See Also:
AbstractTextSearchResult
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description Match[]
computeContainedMatches(AbstractTextSearchResult result, IFile file)
Returns an array with all matches contained in the given file in the given search result.IFile
getFile(Object element)
Returns the file associated with the given element (usually the file the element is contained in).
-
-
-
Method Detail
-
computeContainedMatches
Match[] computeContainedMatches(AbstractTextSearchResult result, IFile file)
Returns an array with all matches contained in the given file in the given search result. If the matches are not contained within anIFile
, this method must return an empty array.- Parameters:
result
- the search result to find matches infile
- the file to find matches in- Returns:
- an array of matches (possibly empty)
-
getFile
IFile getFile(Object element)
Returns the file associated with the given element (usually the file the element is contained in). If the element is not associated with a file, this method should returnnull
.- Parameters:
element
- an element associated with a match- Returns:
- the file associated with the element or
null
-
-