org.netbeans.api.java.source.support

Class LookupBasedJavaSourceTaskFactory

java.lang.Object

org.netbeans.api.java.source.JavaSourceTaskFactory

org.netbeans.api.java.source.support.LookupBasedJavaSourceTaskFactory

public abstract class LookupBasedJavaSourceTaskFactory
extends JavaSourceTaskFactory

A JavaSourceTaskFactory that registers tasks to all files that are found in the given Lookup. This factory searches for FileObject, DataObject and Node in the lookup. If Node(s) are found, its/their lookup is searched for FileObject and DataObject.

Constructor Summary

Constructors

Constructor and Description
LookupBasedJavaSourceTaskFactory(JavaSource.Phase phase, JavaSource.Priority priority) Construct the LookupBasedJavaSourceTaskFactory with given JavaSource.Phase and JavaSource.Priority.
LookupBasedJavaSourceTaskFactory(JavaSource.Phase phase, JavaSource.Priority priority, String... supportedMimeTypes) Construct the LookupBasedJavaSourceTaskFactory with given JavaSource.Phase and JavaSource.Priority.
LookupBasedJavaSourceTaskFactory(JavaSource.Phase phase, JavaSource.Priority priority, TaskIndexingMode taskIndexingMode, String... supportedMimeTypes) Construct the LookupBasedJavaSourceTaskFactory with given JavaSource.Phase and JavaSource.Priority.

Method Summary

Modifier and Type	Method and Description
List<FileObject>	getFileObjects()
protected void	lookupContentChanged() This method is called when the provided Lookup's content changed.
protected void	setLookup(Lookup lookup) Sets a new Lookup to search.

Methods inherited from class org.netbeans.api.java.source.JavaSourceTaskFactory

createTask, fileObjectsChanged, reschedule

Methods inherited from class java.lang.Object

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

Constructor Detail

LookupBasedJavaSourceTaskFactory

public LookupBasedJavaSourceTaskFactory(JavaSource.Phase phase,
                                        JavaSource.Priority priority)

Construct the LookupBasedJavaSourceTaskFactory with given JavaSource.Phase and JavaSource.Priority.

Parameters:

phase - phase to use for tasks created by JavaSourceTaskFactory.createTask(org.openide.filesystems.FileObject)

priority - priority to use for tasks created by JavaSourceTaskFactory.createTask(org.openide.filesystems.FileObject)

LookupBasedJavaSourceTaskFactory

public LookupBasedJavaSourceTaskFactory(JavaSource.Phase phase,
                                        JavaSource.Priority priority,
                                        String... supportedMimeTypes)

Construct the LookupBasedJavaSourceTaskFactory with given JavaSource.Phase and JavaSource.Priority.

Parameters:

phase - phase to use for tasks created by JavaSourceTaskFactory.createTask(org.openide.filesystems.FileObject)

priority - priority to use for tasks created by JavaSourceTaskFactory.createTask(org.openide.filesystems.FileObject)

Since:

0.21

LookupBasedJavaSourceTaskFactory

public LookupBasedJavaSourceTaskFactory(@NonNull
                                        JavaSource.Phase phase,
                                        @NonNull
                                        JavaSource.Priority priority,
                                        @NonNull
                                        TaskIndexingMode taskIndexingMode,
                                        @NonNull
                                        String... supportedMimeTypes)

Construct the LookupBasedJavaSourceTaskFactory with given JavaSource.Phase and JavaSource.Priority.

Parameters:

phase - phase to use for tasks created by JavaSourceTaskFactory.createTask(org.openide.filesystems.FileObject)

priority - priority to use for tasks created by JavaSourceTaskFactory.createTask(org.openide.filesystems.FileObject)

taskIndexingMode - the awareness of indexing. For tasks which can run during indexing use TaskIndexingMode.ALLOWED_DURING_SCAN for tasks which cannot run during indexing use TaskIndexingMode.DISALLOWED_DURING_SCAN.

supportedMimeTypes - a list of mime types on which the tasks created by this factory should be run, empty array falls back to default text/x-java.

Since:

0.94

Method Detail

setLookup

protected final void setLookup(Lookup lookup)

Sets a new Lookup to search.

Parameters:

lookup - new Lookup

getFileObjects

public List<FileObject> getFileObjects()

Specified by:

getFileObjects in class JavaSourceTaskFactory

lookupContentChanged

protected void lookupContentChanged()

This method is called when the provided Lookup's content changed. Subclasses may override this method in order to be notified about such change.