Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 


Eclipse Platform
Release 3.5

org.eclipse.search.ui.text
Interface IFileMatchAdapter


public interface IFileMatchAdapter

This interface serves to map matches to IFile 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 of IFileMatchAdapter from the getFileMatchAdapter() 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
  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 an IFile, this method must return an empty array.

Parameters:
result - the search result to find matches in
file - 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 return null.

Parameters:
element - an element associated with a match
Returns:
the file associated with the element or null

Eclipse Platform
Release 3.5

Guidelines for using Eclipse APIs.

Copyright (c) Eclipse contributors and others 2000, 2008. All rights reserved.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire