Package fr.andross.banitem.database

Class WhitelistedWorld

java.lang.Object

fr.andross.banitem.database.items.Items

fr.andross.banitem.database.WhitelistedWorld

public final class WhitelistedWorld
extends Items

Map containing all allowed items of a world

Version:

3.1.1

Author:

Andross

Field Summary

Fields inherited from class fr.andross.banitem.database.items.Items

customItems, items

Constructor Summary

Constructors

Constructor	Description
WhitelistedWorld(@NotNull org.bukkit.World world, @Nullable List<String> messages, @Nullable List<BanAction> ignored)	This constructor should not be used like this (as it will not been stored into the Whitelist map) Use Whitelist.createNewWhitelistedWorld(World, List, List) instead.

Method Summary

Modifier and Type	Method	Description
void	addNewEntry(@NotNull BannedItem item, @NotNull Map<BanAction,BanActionData> map)	This will add a new entry to the whitelist.
@NotNull Set<BanAction>	getIgnored()	Set of ignored actions, empty if none configured.
@NotNull List<String>	getMessages()	List of messages, empty if none configured.
@NotNull org.bukkit.World	getWorld()	The bukkit world.

Methods inherited from class fr.andross.banitem.database.items.Items

get, get, getAllActions, getCustomItems, getItems, getTotalAmountOfItems

Methods inherited from class java.lang.Object

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

Constructor Details

WhitelistedWorld

public WhitelistedWorld(@NotNull
 @NotNull org.bukkit.World world,
 @Nullable
 @Nullable List<String> messages,
 @Nullable
 @Nullable List<BanAction> ignored)

This constructor should not be used like this (as it will not been stored into the Whitelist map) Use Whitelist.createNewWhitelistedWorld(World, List, List) instead.

Parameters:

world - bukkit world

messages - list of messages to send if the item is not allowed

ignored - list of ignored actions

Method Details

addNewEntry

public void addNewEntry(@NotNull
 @NotNull BannedItem item,
 @NotNull
 @NotNull Map<BanAction,BanActionData> map)

This will add a new entry to the whitelist.

Parameters:

item - banned item (BannedItem)

map - map containing BanAction and their respective BanActionData

getWorld

@NotNull
public @NotNull org.bukkit.World getWorld()

The bukkit world.

Returns:

the bukkit world

getMessages

@NotNull
public @NotNull List<String> getMessages()

List of messages, empty if none configured.

Returns:

list of messages, empty if none configured

getIgnored

@NotNull
public @NotNull Set<BanAction> getIgnored()

Set of ignored actions, empty if none configured.

Returns:

set of ignored actions, empty if none configured