forestry.book

Class ForesterBook

java.lang.Object

forestry.book.ForesterBook

All Implemented Interfaces:

IForesterBook

public class ForesterBook
extends java.lang.Object
implements IForesterBook

Constructor Summary

Constructors

Constructor and Description
ForesterBook()

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)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ForesterBook

public ForesterBook()

Method Detail

getCategoryNames

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

Specified by:

getCategoryNames in interface IForesterBook

Returns:

A collection that contains all unique names of the categories

addCategory

public IBookCategory addCategory(java.lang.String name)

Description copied from interface: IForesterBook

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

Specified by:

addCategory in interface IForesterBook

Parameters:

name - A unique identifier for the category.

Returns:

The created category.

getCategory

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

Specified by:

getCategory in interface IForesterBook

Returns:

The category with the given unique name.

getCategories

public java.util.Collection<IBookCategory> getCategories()

Specified by:

getCategories in interface IForesterBook

Returns:

All categories of this book.

getEntries

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

Specified by:

getEntries in interface IForesterBook

Returns:

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

getEntry

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

Specified by:

getEntry in interface IForesterBook

Returns:

the entry with the given unique name.