LookupBasedJavaSourceTaskFactory (Java Source) - NetBeans API Javadoc (Current Development Version)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

org.netbeans.modules.java.source 0.13.0 1

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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
extends JavaSourceTaskFactory

A JavaSourceTaskFactorySupport 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

LookupBasedJavaSourceTaskFactory(JavaSource.Phase phase, JavaSource.Priority priority)
          Construct the LookupBasedJavaSourceTaskFactory with given JavaSource.Phase and JavaSource.Priority.

Method Summary

List<FileObject> getFileObjects()
          Specifies on which files should be registered tasks created by this factory.

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 Summary
`LookupBasedJavaSourceTaskFactory(JavaSource.Phase phase, JavaSource.Priority priority)` Construct the LookupBasedJavaSourceTaskFactory with given `JavaSource.Phase` and `JavaSource.Priority`.

Method Summary
`List<FileObject>`	`getFileObjects()` Specifies on which files should be registered tasks created by this factory.
`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)

Method Detail

setLookup

protected final void setLookup(Lookup lookup)

Sets a new Lookup to search.

Parameters:: lookup - new Lookup

getFileObjects

public List<FileObject> getFileObjects()

Description copied from class: JavaSourceTaskFactory

Specifies on which files should be registered tasks created by this factory. On JavaSource's corresponding to FileObjects returned from this method will be registered tasks created by the JavaSourceTaskFactory.createTask(org.openide.filesystems.FileObject) method of this factory. If this list changes, a change event should be fired to all registered ChangeListeners.

Specified by:: getFileObjects in class JavaSourceTaskFactory

Returns:: list of FileObject on which tasks from this factory should be registered.
See Also:: JavaSourceTaskFactory.createTask(org.openide.filesystems.FileObject), #addChangeListener, EditorAwareJavaSourceTaskFactory, CaretAwareJavaSourceTaskFactory

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.