forestry.api.book

Interface IForesterBook

All Known Implementing Classes:

ForesterBook

public interface IForesterBook

IForesterBook is the interface that the forestry guide book class implements.

You can get the current instance of the guide book from IBookLoader.loadBook().

Method Summary

Modifier and Type	Method and Description
IBookCategory	addCategory(java.lang.String name) Creates a category, add it to this book and returns it.
java.util.Collection<IBookCategory>	getCategories()
IBookCategory	getCategory(java.lang.String name)
java.util.Collection<java.lang.String>	getCategoryNames()
java.util.Collection<IBookEntry>	getEntries(java.lang.String category)
IBookEntry	getEntry(java.lang.String name)

Method Detail

addCategory

IBookCategory addCategory(java.lang.String name)

Creates a category, add it to this book and returns it.

Parameters:

name - A unique identifier for the category.

Returns:

The created category.

getCategory

@Nullable
IBookCategory getCategory(java.lang.String name)

Returns:

The category with the given unique name.

getCategories

java.util.Collection<IBookCategory> getCategories()

Returns:

All categories of this book.

getCategoryNames

java.util.Collection<java.lang.String> getCategoryNames()

Returns:

A collection that contains all unique names of the categories

getEntries

java.util.Collection<IBookEntry> getEntries(java.lang.String category)

Returns:

A collection that contains all entries of the category with the given name.

getEntry

@Nullable
IBookEntry getEntry(java.lang.String name)

Returns:

the entry with the given unique name.