org.crosswire.common.activate
Interface Activatable

All Known Subinterfaces:
Book
All Known Implementing Classes:
AbstractBook, Backend, GZIPBackend, LuceneIndex, LZSSBackend, PassageAbstractBook, RawBackend, RawLDBackend, ReadingsBook, SwordBook, SwordDictionary, ZLDBackend

public interface Activatable

A class can be Activatable if it needs a significant amount of memory on an irregular basis, and so would benefit from being told when to wake-up and when to conserver memory.

Distribution Licence:
JSword is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, version 2 as published by the Free Software Foundation.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
The License is available on the internet here, or by writing to: Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
The copyright to this program is held by it's authors.

Version:
$Id: Activatable.java,v 1.1 2004/04/20 21:16:09 joe Exp $
Author:
Joe Walker [joe at eireneh dot com]
See Also:
Licence

Method Summary
 void activate(Lock lock)
          Called to indicate that the Book should initialize itself, and consume whatever system resources it needs to be able to respond to other queries.
 void deactivate(Lock lock)
          Called to indicate that the Book should release whatever system resources it can to make way for other uses.
 

Method Detail

activate

void activate(Lock lock)
Called to indicate that the Book should initialize itself, and consume whatever system resources it needs to be able to respond to other queries.

Parameters:
lock - An attempt to ensure that only the Activator calls this method

deactivate

void deactivate(Lock lock)
Called to indicate that the Book should release whatever system resources it can to make way for other uses.

Parameters:
lock - An attempt to ensure that only the Activator calls this method

Copyright ? 2003-2004