More flexible API for file management and syncing

[piotrtomiak]

Genuitec proposes to make some API cleanup/reorganization within File management and synchronisation, especially defining class roles in a better way. Here is a very raw draft of proposed changes:

1. FileManager or better IFileCacheManager, would be responsible for keeping up-to-date list of files on the server
   • IFileCacheManager would work on ITernFile interface and all details of accessing file contents would be responsibility of ITernFile objects
2. File access would be done through ITernFile, with IDETernFile supporting both IFile and File (and possibly others). Public methods:
   • getName()
   • getContents()
   • getAdapter(class) -> returns IFile or File dependeing on the queried class
   • getRelativeFile(String relativePath)
3. ITernProject would not perform any synchronization code itself but redirect any such operations to IFileCacheManager
4. Adpoters will be able to provide different implementations of IFileCacheManager, ITernProject and ITernFile (through appropriate factories).

[angelozerr]

@piotrtomiak I like your idea. The only thing I would like to keep is that all classes from https://github.com/angelozerr/tern.java/tree/master/core must be NOT linked to Eclipse classes. Indead those classes could be used for other IDE (Intellij, Netbeans, etc).

@vrubezhny @dgolovin @mickaelistria @maxandersen @pascalleclercq @gamerson @paulvi @fbricon I think it's an important changes, any comments are welcome. Thank's!

@piotrtomiak do you think it's possible to have a PR for that?

[piotrtomiak]

@angelozerr I see the pattern in core and any proposed mechanisms will be generic, that is not linked to Eclipse in any way

Yes, I will create PR ASAP. Working on changes now.

[angelozerr]

@piotrtomiak I'm waiting for your PR.

Just one question is ITernFile the same thing than TernFile? If it that that's cool, otherwise I would like to avoid creating an instance of ITernFile for IFile and after an instance of TernFile. I think ITernFile an dternFile should be merged. Waiting for your PR...

[piotrtomiak]

@angelozerr That's a good idea, I haven't thought about that. I will see whether this is possible, but it should be. PR should be ready tomorrow morning.

[piotrtomiak]

@angelozerr PR has been created. It took me much more time then I expected, but I think results are worth it. I have tried to describe changes as best as I can. They are vast, but only in file management area. I haven't tried to add any new functionality here (like support for URL based files, or script paths from outside of workspace), but all of that and much more, will now be possible.

ITernFile and TernFile could not be merged together as their nature is different, however, I have created a utility method (ITernFile.toTernServerFile) which takes care of the conversion and allows for custom conversions for particular files.

[maxandersen]

just to link these together the PR is at #154

[piotrtomiak]

@angelozerr since pull request has been merged, I guess you could close this issue.