Home » Java programming language

Java Timer purge() Method with Example

Timer Class purge() method: Here, we are going to learn about the purge() method of Timer Class with its syntax and example.
Submitted by Preeti Jain, on March 26, 2020

Timer Class purge() method

• purge() method is available in java.util package.
• purge() method is used to remove all canceled tasks from the task queue of this Timer.
• purge() method is a non-static method, it is accessible with the class object only and if we try to access the method with the class name then we will get an error.
• purge() method does not throw an exception at the time of canceling task.

Syntax:

    public int purge();

Parameter(s):

• It does not accept any parameter.

Return value:

The return type of the method is int, it returns the removed cancelled task from the queue.

Example:

// Java program to demonstrate the example 
// of int purge() method of Timer

import java.util.*;

class CancelTimer extends TimerTask {
 // Task defined in this method
 public void run() {
  System.out.println("In Stock...Stop Working");
 }
}

public class PurgeOfTimer {
 public static void main(String[] args) {
  // Instantaites a TimerTask and
  // Timer object
  TimerTask task = new CancelTimer();
  Timer tmr = new Timer();

  // By using scheduleAtFixedRate() method isto
  // schedule the task at a constant rate in a
  // repeated manner
  tmr.scheduleAtFixedRate(task, new Date(), 330);

  // By using cancel() method is to
  // cancel this timer and stop
  // the scheduled task
  System.out.println("tmr.cancel(): " + "Cancelled");
  tmr.cancel();

  // By using purge() method is to
  // remove cancelled from the task
  // list
  System.out.println("tmr.purge(): " + tmr.purge());
 }
}

Output

tmr.cancel(): Cancelled
In Stock...Stop Working
tmr.purge(): 0