Carbide.c++

com.nokia.carbide.cpp.epoc.engine.model
Interface IModelDocumentProvider

All Known Implementing Classes:
DefaultModelDocumentProvider

public interface IModelDocumentProvider

This interface is used to look up documents for files.

The provider must detect changes to any IDocument returned and reflect those changes when asked for the file the next time. The provider does not have to persist the contents of the file on a document change, though.

The key used here is File (instead of IPath) since it has proper case sensitivity. Such Files should be absolute canonical filesystem paths.

Since:
Carbide.c++ 1.3

Method Summary
 IDocument getDocument(java.io.File file)
          Locate an existing document or load it.
 

Method Detail

getDocument

IDocument getDocument(java.io.File file)
Locate an existing document or load it. Listen for future changes to the document and to the file.

Parameters:
file - full pathed file
Returns:
IDocument instance; return null only if the file does not exist.

Carbide.c++