001/* ----------------------------------------------------------------------------
002   The Kiwi Toolkit - A Java Class Library
003   Copyright (C) 1998-2004 Mark A. Lindner
004
005   This library is free software; you can redistribute it and/or
006   modify it under the terms of the GNU General Public License as
007   published by the Free Software Foundation; either version 2 of the
008   License, or (at your option) any later version.
009
010   This library is distributed in the hope that it will be useful,
011   but WITHOUT ANY WARRANTY; without even the implied warranty of
012   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013   General Public License for more details.
014
015   You should have received a copy of the GNU General Public License
016   along with this library; if not, write to the Free Software
017   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
018   02111-1307, USA.
019 
020   The author may be contacted at: mark_a_lindner@yahoo.com
021   ----------------------------------------------------------------------------
022   $Log: ProgressObserver.java,v $
023   Revision 1.6  2004/05/05 21:22:45  markl
024   Comment header updates.
025
026   Revision 1.5  2003/01/19 09:42:39  markl
027   Javadoc & comment header updates.
028
029   Revision 1.4  2002/08/11 09:49:19  markl
030   Javadoc fixes.
031
032   Revision 1.3  2001/03/12 03:16:49  markl
033   *** empty log message ***
034
035   Revision 1.2  1999/01/10 03:55:05  markl
036   added GPL header & RCS tag
037   ----------------------------------------------------------------------------
038*/
039
040package kiwi.util;
041
042/** This class defines the behavior of an object that wishes to receive
043  * periodic updates on the progress of a lengthy task.
044  *
045  * @author Mark Lindner
046  */
047
048public interface ProgressObserver 
049  {
050  /** Set the progress amount to <code>progress</code>, which is a value
051    * between 0 and 100. (Out of range values should be silently clipped.)
052    *
053    * @param progress The percentage of the task completed.
054    */
055
056  public void setProgress(int progress);
057  }
058
059/* end of source file */