org.crosswire.common.activate

## Interface Activatable

- All Known Subinterfaces:
    Book
  All Known Implementing Classes:
    AbstractBook, AbstractPassageBook, ReadingsBook, SwordBook, SwordDailyDevotion, SwordDictionary, SwordGenBook, TreeKeyIndex

      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.
  Author:
    Joe Walker
  See Also:
    `The GNU Lesser General Public License for details.`

- - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `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