Package net.gcnt.additionsplus.files.books

Class Book

java.lang.Object

net.gcnt.additionsplus.files.books.Book

public class Book
extends Object

Class that contains all information of a specific custom book.

Constructor Summary

Constructors

Constructor	Description
Book(String name, String author, String title, String generation, int slot, String displayName, List<String> lore, List<String> pages, List<ItemOption> itemOptions, HashMap<org.bukkit.enchantments.Enchantment,Integer> enchantments, List<org.bukkit.inventory.ItemFlag> itemFlags)

Method Summary

Modifier and Type	Method	Description
String	getAuthor()	Get the author of the book.
static Book	getBookByName(String name)	Search a book by its identifier.
String	getBookName()	Get the identifier of the book.
String	getDisplayName()	Deprecated.
HashMap<org.bukkit.enchantments.Enchantment,Integer>	getEnchantments()	Get a list of enchantments, and their strengths, that this book has.
String	getGeneration()	Get the generation of the book.
List<org.bukkit.inventory.ItemFlag>	getItemFlags()	Get a list of item flags that this book has.
List<ItemOption>	getItemOptions()	Get a list of item options that this book has.
List<String>	getLore()	Deprecated.
String	getName()	Get the identifier of the book.
List<String>	getPages()	Get a list of pages from this book.
int	getSlot()	Get the slot to put this book in.
String	getTitle()	Get the title of the book.
void	giveBook(org.bukkit.entity.Player player)	Give the custom book to a player.

Methods inherited from class java.lang.Object

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

Constructor Details

Book

public Book(String name,
 String author,
 String title,
 String generation,
 int slot,
 String displayName,
 List<String> lore,
 List<String> pages,
 List<ItemOption> itemOptions,
 HashMap<org.bukkit.enchantments.Enchantment,Integer> enchantments,
 List<org.bukkit.inventory.ItemFlag> itemFlags)

Method Details

getBookByName

public static Book getBookByName(String name)

Search a book by its identifier.

Parameters:

name - String identifier of the book.

Returns:

Book when found, null when invalid.

getItemFlags

public List<org.bukkit.inventory.ItemFlag> getItemFlags()

Get a list of item flags that this book has.

Returns:

List of ItemFlags.

getEnchantments

public HashMap<org.bukkit.enchantments.Enchantment,Integer> getEnchantments()

Get a list of enchantments, and their strengths, that this book has.

Returns:

HashMap with Enchantments and their Integer strengths.

getItemOptions

public List<ItemOption> getItemOptions()

Get a list of item options that this book has.

Returns:

List of ItemOption.

getName

public String getName()

Get the identifier of the book.

Returns:

String identifier of the book.

getBookName

public String getBookName()

Get the identifier of the book.

Returns:

String identifier of the book.

getAuthor

public String getAuthor()

Get the author of the book.

Returns:

String author of the book.

getTitle

public String getTitle()

Get the title of the book.

Returns:

String title of the book.

getGeneration

public String getGeneration()

Get the generation of the book.

Returns:

String generation of the book.

getPages

public List<String> getPages()

Get a list of pages from this book.

Returns:

String list of pages this book has.

getSlot

public int getSlot()

Get the slot to put this book in.

Returns:

Integer inventory slot if set, -1 by default.

getDisplayName

@Deprecated
public String getDisplayName()

Deprecated.

Get the display name of the book.

Returns:

String display name of the book.

getLore

@Deprecated
public List<String> getLore()

Deprecated.

Get the lore of the book.

Returns:

List String lore of the book.

giveBook

public void giveBook(org.bukkit.entity.Player player)

Give the custom book to a player.

Parameters:

player - Player to give the book to.