java.util.Timer.purge() Method

Description

The purge() method is used to remove all cancelled tasks from this timer's task queue.

Declaration

Following is the declaration for java.util.Timer.purge() method.

public int purge()

Parameters

• NA

Return Value

The method call returns the number of tasks removed from the queue.

Exception

• NA

Example

The following example shows the usage of java.util.Timer.purge()

package com.tutorialspoint;

import java.util.*;

public class TimerDemo {
   public static void main(String[] args) {
      // creating timer task, timer
      TimerTask tasknew = new TimerCancel();
      Timer timer = new Timer();
      
      // scheduling the task
      timer.scheduleAtFixedRate(tasknew, new Date(), 10); 
      
      // cancel task
      timer.cancel();
      
      // purging the timer
      System.out.println("purge value :"+timer.purge());      
   }
   // this method performs the task
   public void run() {
      System.out.println("working on");      
   }    
}

Let us compile and run the above program, this will produce the following result.

working on
purge value :0