Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

Source code: javatools/util/Resetable.java


1   /*
2       Javatools (modified version) - Some useful general classes.
3       Copyright (C) 2002-2003  Chris Bitmead (original) Antonio Petrelli (modified)
4   
5       This program is free software; you can redistribute it and/or modify
6       it under the terms of the GNU General Public License as published by
7       the Free Software Foundation; either version 2 of the License, or
8       (at your option) any later version.
9   
10      This program is distributed in the hope that it will be useful,
11      but WITHOUT ANY WARRANTY; without even the implied warranty of
12      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13      GNU General Public License for more details.
14  
15      You should have received a copy of the GNU General Public License
16      along with this program; if not, write to the Free Software
17      Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18  
19      Contact me at: brenmcguire@users.sourceforge.net
20   */
21  package javatools.util;
22  
23  /**
24   * Any object that can be "Reseted" implements this. The meaning of "reset"
25   * is rather ill-defined, but usually means to bring itself back to a starting
26   * state, to clear its caches and/or to re-read configuration files.
27   * @author Chris Bitmead
28   * @version 0.7
29   * @commentedby Antonio Petrelli (the method).
30   */
31  public interface Resetable {
32      /** Resets an object.
33       * @throws ResetException If something goes wrong.
34       */    
35    public void reset() throws ResetException;
36  }