com.bellman.bible.android.control.navigation.DocumentBibleBooksFactory.java Source code

Introduction

Here is the source code for com.bellman.bible.android.control.navigation.DocumentBibleBooksFactory.java

Source

package com.bellman.bible.android.control.navigation;

import android.support.v4.util.LruCache;

import org.crosswire.jsword.book.Books;
import org.crosswire.jsword.book.BooksEvent;
import org.crosswire.jsword.book.BooksListener;
import org.crosswire.jsword.book.basic.AbstractPassageBook;
import org.crosswire.jsword.versification.BibleBook;

import java.util.List;

/**
 * Caching factory for {@link DocumentBibleBooks}.
 *
 * @author Martin Denham [mjdenham at gmail dot com]
 * @see gnu.lgpl.License for license details.<br>
 * The copyright to this program is held by it's author.
 */
public class DocumentBibleBooksFactory {

    private static final int CACHE_SIZE = 10;
    private LruCache<AbstractPassageBook, DocumentBibleBooks> cache;

    public DocumentBibleBooksFactory() {
        // initialise the DocumentBibleBooks factory
        cache = new LruCache<AbstractPassageBook, DocumentBibleBooks>(CACHE_SIZE) {

            /** If entry for this Book not found in cache then create one
             */
            @Override
            protected DocumentBibleBooks create(AbstractPassageBook document) {
                return new DocumentBibleBooks(document);
            }
        };
    }

    public void initialise() {
        // this used to cause errors on restart e.g. after changing language, due to attempt to init sword before settings so call it some time after initialisation
        // hopefully now sorted by delayed initialisation
        flushCacheIfBooksChange();
    }

    public DocumentBibleBooks getDocumentBibleBooksFor(AbstractPassageBook document) {
        return cache.get(document);
    }

    public List<BibleBook> getBooksFor(AbstractPassageBook document) {
        return getDocumentBibleBooksFor(document).getBookList();
    }

    /**
     * Different versions of a Book may contain different Bible books so flush cache if a Book may have been updated
     */
    private void flushCacheIfBooksChange() {
        Books.installed().addBooksListener(new BooksListener() {
            @Override
            public void bookAdded(BooksEvent ev) {
                cache.evictAll();
            }

            @Override
            public void bookRemoved(BooksEvent ev) {
                cache.evictAll();
            }
        });
    }
}