Package fr.andross.banitem.database.items

Class Items

java.lang.Object

fr.andross.banitem.database.items.Items

Direct Known Subclasses:

WhitelistedWorld

public class Items
extends Object

Map that store all the banned items, with their actions and actions data.

Version:

3.1.1

Author:

Andross

Field Summary

Fields

Modifier and Type	Field	Description
protected final Map<CustomBannedItem,Map<BanAction,BanActionData>>	customItems	Items map, containing all custom items.
protected final Map<BannedItem,Map<BanAction,BanActionData>>	items	Items map, containing all items.

Constructor Summary

Constructors

Constructor	Description
Items()	Constructor

Method Summary

Modifier and Type	Method	Description
@Nullable Map<BanAction,BanActionData>	get(@NotNull BannedItem bannedItem)	Get a map of actions and their respective data for a banned item object, if present.
@Nullable BanActionData	get(@NotNull BannedItem bannedItem, @NotNull BanAction action)	Get the BanActionData of the BannedItem for the said action, if present.
@NotNull @Unmodifiable Set<BanAction>	getAllActions()	Get all actions saved for the items, unmodifiable.
@NotNull Map<CustomBannedItem,Map<BanAction,BanActionData>>	getCustomItems()	Get the custom items map.
@NotNull Map<BannedItem,Map<BanAction,BanActionData>>	getItems()	Get the items map (include normal and meta items).
int	getTotalAmountOfItems()	Get the total amount of items added.

Methods inherited from class java.lang.Object

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

Field Details

items

protected final Map<BannedItem,Map<BanAction,BanActionData>> items

Items map, containing all items. Includes normal and meta items.

customItems

protected final Map<CustomBannedItem,Map<BanAction,BanActionData>> customItems

Items map, containing all custom items.

Constructor Details

Items

public Items()

Constructor

Method Details

get

@Nullable
public @Nullable Map<BanAction,BanActionData> get(@NotNull
 @NotNull BannedItem bannedItem)

Get a map of actions and their respective data for a banned item object, if present.

Parameters:

bannedItem - the banned item

Returns:

a map of actions and data if found, otherwise null.

get

@Nullable
public @Nullable BanActionData get(@NotNull
 @NotNull BannedItem bannedItem,
 @NotNull
 @NotNull BanAction action)

Get the BanActionData of the BannedItem for the said action, if present.

Parameters:

bannedItem - the banned item

action - the action

Returns:

the BanActionData if found, otherwise null.

getItems

@NotNull
public @NotNull Map<BannedItem,Map<BanAction,BanActionData>> getItems()

Get the items map (include normal and meta items).

Returns:

the items map

getCustomItems

@NotNull
public @NotNull Map<CustomBannedItem,Map<BanAction,BanActionData>> getCustomItems()

Get the custom items map.

Returns:

the custom items map

getTotalAmountOfItems

public int getTotalAmountOfItems()

Get the total amount of items added.

Returns:

the total amount of items added

getAllActions

@NotNull
public @NotNull @Unmodifiable Set<BanAction> getAllActions()

Get all actions saved for the items, unmodifiable.

Returns:

all actions saved for the items