java/src/main/com/google/appengine/tools/admin/UpdateProgressEvent.java

   1 // Copyright 2008 Google Inc. All Rights Reserved.
   2
   3 package com.google.appengine.tools.admin;
   4
   5 /**
   6  * Received by an {@link com.google.appengine.tools.admin.UpdateListener}
   7  * periodically during an operation to indicate progress.
   8  *
   9  */
  10 public class UpdateProgressEvent {
  11
  12   private String message;
  13   private int percentageComplete;
  14   private Thread updateThread;
  15
  16   public UpdateProgressEvent(Thread updateThread, String message, int percentageComplete) {
  17     this.message = message;
  18     this.percentageComplete = percentageComplete;
  19     this.updateThread = updateThread;
  20   }
  21
  22   /**
  23    * Cancels the operation. A
  24    * {@link com.google.appengine.tools.admin.AppAdmin#rollback rollback} is
  25    * implicitly issued.
  26    */
  27   public void cancel() {
  28     updateThread.interrupt();
  29   }
  30
  31   /**
  32    * Retrieves the current status message.
  33    *
  34    * @return a not {@code null} status message.
  35    */
  36   public String getMessage() {
  37     return message;
  38   }
  39
  40   /**
  41    * Retrieves the current percentage complete.
  42    *
  43    * @return a number inclusively between 0 and 100.
  44    */
  45   public int getPercentageComplete() {
  46     return percentageComplete;
  47   }
  48 }