Skip navigation links

oracle.ide.index
Class IndexManager

java.lang.Object
oracle.ide.index.IndexManager

public abstract class IndexManager

extends java.lang.Object

Manages Index instances.

Constructor Summary

IndexManager()

Method Summary

abstract void	addIndexer(java.lang.Class<? extends Indexer> indexer) Add an Indexer class which will be called for all files being indexed.
abstract void	addIndexer(java.lang.Class<? extends Node> nodeClass, java.lang.Class<? extends Indexer> indexer) Add an Indexer class for files with the given Node type.
abstract Index	getIndex(Project project) Get the index for the given project.
abstract Index	getIndex(Project project, ContentSet content) Get the index for the given ContentSet in the scope of the given project.
abstract Index	getIndex(Project project, java.net.URL url) Get the index for the given URL in the scope of the given project.
abstract Index	getIndex(Project project, URLPath path) Get the index for the given URLPath in the scope of the given project.
static IndexManager	getIndexManager() Get the IndexManager implementation.
static void	setIndexManager(IndexManager indexManager) Set the IndexManager implementation.

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexManager

public IndexManager()

Method Detail

getIndexManager

public static IndexManager getIndexManager()

Get the IndexManager implementation.

Returns:

the IndexManager implementation

setIndexManager

public static void setIndexManager(IndexManager indexManager)

Set the IndexManager implementation.

Parameters:

indexManager - the IndexManager implementation

getIndex

public abstract Index getIndex(Project project)

Get the index for the given project. The index will include all of the project content, but not its libraries, dependencies, JDK, etc. It is the caller's responsibility to call Index.release() when they are finished with this index.

Parameters:

project - the project

Returns:

the index for the project

getIndex

public abstract Index getIndex(Project project,
                               ContentSet content)

Get the index for the given ContentSet in the scope of the given project. This can be used, for example, to get an index for a subset of the project content. It is the caller's responsibility to call Index.release() when they are finished with this index.

Parameters:

project - the project

content - the content set

Returns:

the index

getIndex

public abstract Index getIndex(Project project,
                               URLPath path)

Get the index for the given URLPath in the scope of the given project. This can be used, for example, to index a library used by a project. Note that this method should not be used to index paths from a content set, as doing so would ignore the filters from the content set. This can result in far more files being indexed than is necessary. For content sets, use #getIndex(Project,ContentSet). It is the caller's responsibility to call Index.release() when they are finished with this index.

Parameters:

project - the project

path - the URL path

Returns:

the index

getIndex

public abstract Index getIndex(Project project,
                               java.net.URL url)

Get the index for the given URL in the scope of the given project. Note that this method should not be used to index paths from a content set, as doing so would ignore the filters from the content set. This can result in far more files being indexed than is necessary. For content sets, use #getIndex(Project,ContentSet). It is the caller's responsibility to call Index.release() when they are finished with this index.

Parameters:

project - the project

url - the URL

Returns:

the index

addIndexer

public abstract void addIndexer(java.lang.Class<? extends Indexer> indexer)

Add an Indexer class which will be called for all files being indexed.

Parameters:

indexer - the Indexer class to be added

addIndexer

public abstract void addIndexer(java.lang.Class<? extends Node> nodeClass,
                                java.lang.Class<? extends Indexer> indexer)

Add an Indexer class for files with the given Node type. Note that multiple indexers can be added for a given file type. They will be called in the order they were added.

Parameters:

nodeClass - the Node subclass

indexer - the Indexer class to be added

Skip navigation links