Coverage Report

Coverage Report - org.argouml.taskmgmt.ProgressMonitor

Classes in this File

 /* $Id: ProgressMonitor.java 17840 2010-01-12 19:09:10Z linus $
  *****************************************************************************
  * Copyright (c) 2009 Contributors - see below
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
  * http://www.eclipse.org/legal/epl-v10.html
  *
  * Contributors:
  *    mvw
  *****************************************************************************
  *
  * Some portions of this file was previously release using the BSD License:
  */
 
 // Copyright (c) 2006-2007 The Regents of the University of California. All
 // Rights Reserved. Permission to use, copy, modify, and distribute this
 // software and its documentation without fee, and without a written
 // agreement is hereby granted, provided that the above copyright notice
 // and this paragraph appear in all copies.  This software program and
 // documentation are copyrighted by The Regents of the University of
 // California. The software program and documentation are supplied "AS
 // IS", without any accompanying services from The Regents. The Regents
 // does not warrant that the operation of the program will be
 // uninterrupted or error-free. The end-user understands that the program
 // was developed for research purposes and is advised not to rely
 // exclusively on the program for any reason.  IN NO EVENT SHALL THE
 // UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
 // SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
 // ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
 // THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
 // SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
 // WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
 // PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
 // CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
 // UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 
 package org.argouml.taskmgmt;
 
 
 /**
  * This is a generic progress notifier. Can be used with any GUI progress bar
  * or any other progress GUI. It's this way to be independent of the GUI
  * implementation.
  * @author Bogdan Pistol
  */
 public interface ProgressMonitor extends ProgressListener {
     
     /**
      * Informs the progress tool that the total progress was updated.
      * 
      * @param progress the amount of progress done so far, this is the whole
      * progress until now, not just the subtask's progress or the
      * main task's progress
      */
     void updateProgress(int progress);
     
     /**
      * Updates the subtask that is in progress.
      * @param name the name of the subtask
      */
     void updateSubTask(String name);
     
     /**
      * Updates the major task that is going on.
      * @param name the new task
      */
     void updateMainTask(String name);
     
     /**
      * Determines if the user wants to cancel the current action.
      * If this happens the current action should be stopped.
      * <p>
      * So in a long running action, you should query this periodicaly to see
      * if the user still wants to continue or he canceled the action.
      * <p>
      * NOTE: It appears to be some kind of Java tradition to misspell
      * the name of this method, so we follow the Swing and Eclipse tradition
      * of spelling it with a single "L".
      * @return true if the user cancelled the action and false otherwise
      */
     boolean isCanceled();
     
     /**
      * Determines the maximum amount of progress that can be reached.
      * This should be set before the progress is updated.
      * @param max the maximum progress value or -1 if the value is unknown
      */
     void setMaximumProgress(int max);
     
     /**
      * This method notifies the GUI that the working thread determines that
      * there are no actions that could be done for various reasons.
      * The GUI should notify the user too.
      */
     void notifyNullAction();
     
     /**
      * If something happens the user should be notified.
      * @param title a title for the error/information/etc
      * @param introduction a short message that will continue with the message
      * @param message the actual message with all the details
      */
     void notifyMessage(String title, String introduction, String message);
 
      /** 
      * Indicate that the operation is complete.  This happens automatically
      * when the value set by setProgress is >= max, but it may be called
      * earlier if the operation ends early.
      */
     public void close();
 
 }

1		/* $Id: ProgressMonitor.java 17840 2010-01-12 19:09:10Z linus $
2		*****************************************************************************
3		* Copyright (c) 2009 Contributors - see below
4		* All rights reserved. This program and the accompanying materials
5		* are made available under the terms of the Eclipse Public License v1.0
6		* which accompanies this distribution, and is available at
7		* http://www.eclipse.org/legal/epl-v10.html
8		*
9		* Contributors:
10		* mvw
11		*****************************************************************************
12		*
13		* Some portions of this file was previously release using the BSD License:
14		*/
15
16		// Copyright (c) 2006-2007 The Regents of the University of California. All
17		// Rights Reserved. Permission to use, copy, modify, and distribute this
18		// software and its documentation without fee, and without a written
19		// agreement is hereby granted, provided that the above copyright notice
20		// and this paragraph appear in all copies. This software program and
21		// documentation are copyrighted by The Regents of the University of
22		// California. The software program and documentation are supplied "AS
23		// IS", without any accompanying services from The Regents. The Regents
24		// does not warrant that the operation of the program will be
25		// uninterrupted or error-free. The end-user understands that the program
26		// was developed for research purposes and is advised not to rely
27		// exclusively on the program for any reason. IN NO EVENT SHALL THE
28		// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
29		// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
30		// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
31		// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
32		// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
33		// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
34		// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
35		// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
36		// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
37		// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
38
39		package org.argouml.taskmgmt;
40
41
42		/**
43		* This is a generic progress notifier. Can be used with any GUI progress bar
44		* or any other progress GUI. It's this way to be independent of the GUI
45		* implementation.
46		* @author Bogdan Pistol
47		*/
48		public interface ProgressMonitor extends ProgressListener {
49
50		/**
51		* Informs the progress tool that the total progress was updated.
52		*
53		* @param progress the amount of progress done so far, this is the whole
54		* progress until now, not just the subtask's progress or the
55		* main task's progress
56		*/
57		void updateProgress(int progress);
58
59		/**
60		* Updates the subtask that is in progress.
61		* @param name the name of the subtask
62		*/
63		void updateSubTask(String name);
64
65		/**
66		* Updates the major task that is going on.
67		* @param name the new task
68		*/
69		void updateMainTask(String name);
70
71		/**
72		* Determines if the user wants to cancel the current action.
73		* If this happens the current action should be stopped.
74		* <p>
75		* So in a long running action, you should query this periodicaly to see
76		* if the user still wants to continue or he canceled the action.
77		* <p>
78		* NOTE: It appears to be some kind of Java tradition to misspell
79		* the name of this method, so we follow the Swing and Eclipse tradition
80		* of spelling it with a single "L".
81		* @return true if the user cancelled the action and false otherwise
82		*/
83		boolean isCanceled();
84
85		/**
86		* Determines the maximum amount of progress that can be reached.
87		* This should be set before the progress is updated.
88		* @param max the maximum progress value or -1 if the value is unknown
89		*/
90		void setMaximumProgress(int max);
91
92		/**
93		* This method notifies the GUI that the working thread determines that
94		* there are no actions that could be done for various reasons.
95		* The GUI should notify the user too.
96		*/
97		void notifyNullAction();
98
99		/**
100		* If something happens the user should be notified.
101		* @param title a title for the error/information/etc
102		* @param introduction a short message that will continue with the message
103		* @param message the actual message with all the details
104		*/
105		void notifyMessage(String title, String introduction, String message);
106
107		/**
108		* Indicate that the operation is complete. This happens automatically
109		* when the value set by setProgress is >= max, but it may be called
110		* earlier if the operation ends early.
111		*/
112		public void close();
113
114		}