forestry.api.book

Interface IBookLoader

All Known Implementing Classes:

BookLoader

public interface IBookLoader

Method Summary

Modifier and Type	Method and Description
IBookPageFactory	getPageFactory(java.lang.String name)
void	invalidateBook() Invalidates the current instance of the book.
IForesterBook	loadBook() Loads the book if it was not loaded already or if it was invalidated.
void	registerContentType(java.lang.String name, java.lang.Class<? extends BookContent> contentClass) Adds a content type.
void	registerPageFactory(java.lang.String name, IBookPageFactory factory)

Method Detail

registerContentType

void registerContentType(java.lang.String name,
                         java.lang.Class<? extends BookContent> contentClass)

Adds a content type.

Parameters:

name - The name of the content type.

contentClass - The class for the deserialization of the content.

registerPageFactory

void registerPageFactory(java.lang.String name,
                         IBookPageFactory factory)

getPageFactory

IBookPageFactory getPageFactory(java.lang.String name)

loadBook

IForesterBook loadBook()

Loads the book if it was not loaded already or if it was invalidated. Otherwise it returns the last loaded instance.

Returns:

The current instance of the forestry guide book.

invalidateBook

void invalidateBook()

Invalidates the current instance of the book. The next time loadBook() gets called a new instance of the book will be loaded.