oracle.ide.model

Class AsynchronousContentLevelFilter

java.lang.Object

oracle.ide.model.ContentLevelFilter

oracle.ide.model.AsynchronousContentLevelFilter

public abstract class AsynchronousContentLevelFilter
extends ContentLevelFilter

Extends ContentLevelFilter by defining asynchronous semantics. updateDir will The updateDir method will not necesarily be called on the AWT event dispatch thread, and the IDE may call cancelUpdateDir() to request that updateDir be stopped.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AsynchronousContentLevelFilter(java.lang.String[] contentSetKeys) Creates a ContentLevelFilter that works on the content sets with the specified keys.

Method Summary

Modifier and Type	Method and Description
abstract void	cancelUpdateDir()
abstract java.util.concurrent.Callable<java.util.List<Subject>>	getUpdateDirRequestHandler() Gets a Callable object that will perform the asynchronous request.
void	postUpdateDirRequestHandlerSubmitted(URLPath srcRoots, java.lang.String dirRelPath, java.util.List elementList) Can be optionally overriden after the asynchronous request from getUpdateDirRequestHandler has been submitted for execution.

Methods inherited from class oracle.ide.model.ContentLevelFilter

updateDir

Methods inherited from class java.lang.Object

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

Constructor Detail

AsynchronousContentLevelFilter

protected AsynchronousContentLevelFilter(java.lang.String[] contentSetKeys)

Creates a ContentLevelFilter that works on the content sets with the specified keys.

Parameters:

contentSetKeys - A non-null, non-empty array of content set keys for which this ContentLevelFilter will apply. All of the keys must be a value returned by some ContentSetProvider.getKey() method.

Throws:

java.lang.IllegalArgumentException - if contentSetKeys is null or empty or if any item in the contentSetKeys array is null.

Method Detail

getUpdateDirRequestHandler

public abstract java.util.concurrent.Callable<java.util.List<Subject>> getUpdateDirRequestHandler()

Gets a Callable object that will perform the asynchronous request. Guaranteed to be preceeded by a call to ContentLevelFilter.updateDir The return value is a list of Subjects whose structure has changed as a result of the asynchronous operation, and whose observers will need to be notified.

Returns:

list of Subjects whose observers are to be notified once the asynchronous operations has completed.

See Also:

UpdateMessage.fireStructureChanged(Subject)

postUpdateDirRequestHandlerSubmitted

public void postUpdateDirRequestHandlerSubmitted(URLPath srcRoots,
                                                 java.lang.String dirRelPath,
                                                 java.util.List elementList)

Can be optionally overriden after the asynchronous request from getUpdateDirRequestHandler has been submitted for execution. Executed synchronously. Defaults to no-op.

Parameters:

srcRoots - see ContentLevelFilter.updateDir

dirRelPath - see ContentLevelFilter.updateDir

elementList - see ContentLevelFilter.updateDir

cancelUpdateDir

public abstract void cancelUpdateDir()