oracle.ide.index.file
Class FileTableManager

java.lang.Object
  oracle.ide.index.file.FileTableManager

public abstract class FileTableManager
extends java.lang.Object

Manages FileTable instances.

Constructor Summary

FileTableManager()

Method Summary

FileTable	getFileTable(Project project, java.net.URL root) Get a file table for the given root directory.
abstract FileTable	getFileTable(Project project, java.net.URL root, PatternFilters filters) Get a file table for the given root directory.
static FileTableManager	getFileTableManager() Get the FileTableManager implementation.
abstract void	invalidateDir(java.net.URL directory, boolean subdirs) Invalidate file table data for the given directory, and optionally its subdirectories.
abstract void	invalidateFile(java.net.URL file) Invalidate file table data for the given file.
static void	setFileTableManager(FileTableManager fileTableManager) Set the FileTableManager implementation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileTableManager

public FileTableManager()

Method Detail

getFileTableManager

public static FileTableManager getFileTableManager()

Get the FileTableManager implementation.

Returns:

the FileTableManager implementation

setFileTableManager

public static void setFileTableManager(FileTableManager fileTableManager)

Set the FileTableManager implementation.

Parameters:

fileTableManager - the FileTableManager implementation

getFileTable

public FileTable getFileTable(Project project,
                              java.net.URL root)
                       throws java.lang.InterruptedException,
                              java.util.concurrent.ExecutionException

Get a file table for the given root directory. The file table is updated before this method returns. An immutable snapshot of the updated file table is returned, so the caller is guaranteed that the contents of the returned file table will not change.

It is the caller's responsibility to call FileTable.release() when they are done with the file table.

Parameters:

project - the project

root - the root directory

Returns:

the background task which updates the file table

Throws:

java.lang.InterruptedException - if the file table update is interrupted

java.util.concurrent.ExecutionException - if the file table update fails

java.util.concurrent.RejectedExecutionException - if the file table service has been shut down

getFileTable

public abstract FileTable getFileTable(Project project,
                                       java.net.URL root,
                                       PatternFilters filters)
                                throws java.lang.InterruptedException,
                                       java.util.concurrent.ExecutionException

Get a file table for the given root directory. The file table is updated before this method returns. An immutable snapshot of the updated file table is returned, so the caller is guaranteed that the contents of the returned file table will not change.

It is the caller's responsibility to call FileTable.release() when they are done with the file table.

Parameters:

project - the project

root - the root directory

filters - the filters

Returns:

the background task which updates the file table

Throws:

java.lang.InterruptedException - if the file table update is interrupted

java.util.concurrent.ExecutionException - if the file table update fails

java.util.concurrent.RejectedExecutionException - if the file table service has been shut down

invalidateFile

public abstract void invalidateFile(java.net.URL file)

Invalidate file table data for the given file.

Parameters:

file - the file to invalidate

invalidateDir

public abstract void invalidateDir(java.net.URL directory,
                                   boolean subdirs)

Invalidate file table data for the given directory, and optionally its subdirectories.

Parameters:

directory - the directory to invalidate

subdirs - whether to invalidate subdirectories