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: Activatable.java 1966 2009-10-30 01:15:14Z dmsmith $
21   */
22  package org.crosswire.common.activate;
23  
24  /**
25   * A class can be Activatable if it needs a significant amount of memory on an
26   * irregular basis, and so would benefit from being told when to wake-up and
27   * when to conserver memory.
28   * 
29   * @see gnu.lgpl.License for license details.<br>
30   *      The copyright to this program is held by it's authors.
31   * @author Joe Walker [joe at eireneh dot com]
32   */
33  public interface Activatable {
34      /**
35       * Called to indicate that the Book should initialize itself, and consume
36       * whatever system resources it needs to be able to respond to other
37       * queries.
38       * 
39       * @param lock
40       *            An attempt to ensure that only the Activator calls this method
41       */
42      void activate(Lock lock);
43  
44      /**
45       * Called to indicate that the Book should release whatever system resources
46       * it can to make way for other uses.
47       * 
48       * @param lock
49       *            An attempt to ensure that only the Activator calls this method
50       */
51      void deactivate(Lock lock);
52  }
53