io.github.portlek.smartinventory.icon

Class BasicIcon

java.lang.Object

io.github.portlek.smartinventory.icon.BasicIcon

All Implemented Interfaces:

Icon

public final class BasicIcon
extends Object
implements Icon

an implementation for Icon.

Field Summary

Fields inherited from interface io.github.portlek.smartinventory.Icon

EMPTY

Constructor Summary

Constructors

Constructor and Description
BasicIcon(@NotNull org.bukkit.inventory.ItemStack item) ctor.

Method Summary

Modifier and Type	Method and Description
<T extends IconEvent> void	accept(T event) accepts the upcoming event for all of the handles.
@NotNull org.bukkit.inventory.ItemStack	calculateItem(@NotNull InventoryContents contents) calculates and returns the item of the icon.
@NotNull Icon	canSee(@NotNull Predicate<InventoryContents> predicate) sets the canSee value of the icon to the given predicate.
@NotNull Icon	canUse(@NotNull Predicate<InventoryContents> predicate) sets the canUse value of the icon to the given predicate.
@NotNull Icon	fallback(@NotNull org.bukkit.inventory.ItemStack fallback) sets the fallback item of the icon to the given item.
@NotNull org.bukkit.inventory.ItemStack	getItem() obtains the icon's ItemStack.
<T extends IconEvent> @NotNull Icon	handle(@NotNull Handle<T> handle) adds the given handle into the icon's handle list.
@NotNull Icon	handles(@NotNull Collection<Handle<? extends IconEvent>> handles) adds all the given handles into the icon's handle list.
@NotNull Icon	item(@NotNull org.bukkit.inventory.ItemStack item) sets the item of the icon to the given item.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.portlek.smartinventory.Icon

cancel, click, drag, from, handle, whenClick, whenClick, whenDrag, whenDrag, whenInteract, whenInteract

Constructor Detail

BasicIcon

public BasicIcon(@NotNull
                 @NotNull org.bukkit.inventory.ItemStack item)

ctor.

Parameters:

item - the item.

Method Detail

getItem

@NotNull
public @NotNull org.bukkit.inventory.ItemStack getItem()

Description copied from interface: Icon

obtains the icon's ItemStack.

Specified by:

getItem in interface Icon

Returns:

the icon's item.

calculateItem

@NotNull
public @NotNull org.bukkit.inventory.ItemStack calculateItem(@NotNull
                                                                      @NotNull InventoryContents contents)

Description copied from interface: Icon

calculates and returns the item of the icon. tests the canSee with the given contents, and if it returns true, returns Icon.getItem() else, returns the fallback.

Specified by:

calculateItem in interface Icon

Parameters:

contents - the contents to calculate.

Returns:

the calculated item.

accept

public <T extends IconEvent> void accept(@NotNull
                                         T event)

Description copied from interface: Icon

accepts the upcoming event for all of the handles.

Specified by:

accept in interface Icon

Type Parameters:

T - type of the event.

Parameters:

event - the event to accept.

handle

@NotNull
public <T extends IconEvent> @NotNull Icon handle(@NotNull
                                                           @NotNull Handle<T> handle)

Description copied from interface: Icon

adds the given handle into the icon's handle list.

Specified by:

handle in interface Icon

Type Parameters:

T - type of the event.

Parameters:

handle - the handle to add.

Returns:

this, for chained calls.

handles

@NotNull
public @NotNull Icon handles(@NotNull
                                      @NotNull Collection<Handle<? extends IconEvent>> handles)

Description copied from interface: Icon

adds all the given handles into the icon's handle list.

Specified by:

handles in interface Icon

Parameters:

handles - the handles to add.

Returns:

this, for chained calls.

canSee

@NotNull
public @NotNull Icon canSee(@NotNull
                                     @NotNull Predicate<InventoryContents> predicate)

Description copied from interface: Icon

sets the canSee value of the icon to the given predicate.

Specified by:

canSee in interface Icon

Parameters:

predicate - the predicate to set.

Returns:

this, for chained calls.

canUse

@NotNull
public @NotNull Icon canUse(@NotNull
                                     @NotNull Predicate<InventoryContents> predicate)

Description copied from interface: Icon

sets the canUse value of the icon to the given predicate.

Specified by:

canUse in interface Icon

Parameters:

predicate - the predicate to set.

Returns:

this, for chained calls.

fallback

@NotNull
public @NotNull Icon fallback(@NotNull
                                       @NotNull org.bukkit.inventory.ItemStack fallback)

Description copied from interface: Icon

sets the fallback item of the icon to the given item.

Specified by:

fallback in interface Icon

Parameters:

fallback - the fallback to set.

Returns:

this, for chained calls.

item

@NotNull
public @NotNull Icon item(@NotNull
                                   @NotNull org.bukkit.inventory.ItemStack item)

Description copied from interface: Icon

sets the item of the icon to the given item.

Specified by:

item in interface Icon

Parameters:

item - the item to set.

Returns:

this, for chained calls.