1   /**
2    * Distribution License:
3    * JSword is free software; you can redistribute it and/or modify it under
4    * the terms of the GNU Lesser General Public License, version 2.1 as published by
5    * the Free Software Foundation. This program is distributed in the hope
6    * that it will be useful, but WITHOUT ANY WARRANTY; without even the
7    * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
8    * See the GNU Lesser General Public License for more details.
9    *
10   * The License is available on the internet at:
11   *       http://www.gnu.org/copyleft/lgpl.html
12   * or by writing to:
13   *      Free Software Foundation, Inc.
14   *      59 Temple Place - Suite 330
15   *      Boston, MA 02111-1307, USA
16   *
17   * Copyright: 2005
18   *     The copyright to this program is held by it's authors.
19   *
20   * ID: $Id: Clearable.java 1966 2009-10-30 01:15:14Z dmsmith $
21   */
22  package org.crosswire.common.swing.desktop;
23  
24  /**
25   * A Clearable object can be cleared and can be queried to see if it is cleared.
26   * 
27   * @see gnu.lgpl.License for license details.<br>
28   *      The copyright to this program is held by it's authors.
29   * @author DM Smith [ dmsmith555 at yahoo dot com]
30   */
31  public interface Clearable {
32      /**
33       * Clear this object, resetting it back to its initial state.
34       */
35      void clear();
36  
37      /**
38       * Determine whether this object is in its initial state.
39       * 
40       * @return whether this object is clear.
41       */
42      boolean isClear();
43  }
44