oracle.ide.navigator

Class RefreshTask

java.lang.Object

oracle.ide.navigator.RefreshTask

public abstract class RefreshTask
extends java.lang.Object

Class should be used as a super-class for a refresh task implementation. Such an implementation class can be then registered as a refresh-hook. Then, the task will run as a part of navigator refresh with appropriate context and progress handle.

Provides an empty implementation of refresh(Context, ProgressHandle) and refreshApplication(Context, ProgressHandle) methods.

The following example shows the 5 seconds task which periodically check for thread interruption. Thread can be interrupted either by user cancellation (clicking the cross (x) button) or by invoking the new refresh action. When implementing your refresh method, test for interruption Thread.interrupted() as often as possible and if true, finish your task.

  public static class TimeVastingTask extends RefreshTaskAdapter {
 
    public String getDisplayName() {
        return "Time Vasting Task";
    }

    public void run() {
        try {
            for (int i = 0; i < 10; i++) {
            Thread.sleep(500);
            if (Thread.interrupted()) {
                String time = Integer.toString(500 + i*500);
                System.out.println("Cancelled after " +  time + " ms.");
                return;
            }
        } catch (InterruptedException e) {
          System.out.println(e);
        }
    }
  }   
 

The class instance has to be registered in your extension.xml:

 <refresh-hook xmlns="http://xmlns.oracle.com/ide/extension">
     <observer>yourpackage.TimeVastingTask</observer>
 </refresh-hook>
 

See Also:

Thread

Constructor Summary

Constructors

Constructor and Description
RefreshTask()

Method Summary

Methods

Modifier and Type	Method and Description
abstract java.lang.String	getDisplayName()
void	refresh(Context context, org.netbeans.api.progress.ProgressHandle handle)
void	refreshApplication(Context context, org.netbeans.api.progress.ProgressHandle handle)

Methods inherited from class java.lang.Object

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

Constructor Detail

RefreshTask

public RefreshTask()

Method Detail

getDisplayName

public abstract java.lang.String getDisplayName()

refresh

public void refresh(Context context,
           org.netbeans.api.progress.ProgressHandle handle)
             throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException

refreshApplication

public void refreshApplication(Context context,
                      org.netbeans.api.progress.ProgressHandle handle)
                        throws java.lang.InterruptedException

Throws:

java.lang.InterruptedException