io.github.portlek.smartinventory

Interface Icon

All Known Implementing Classes:

BasicIcon

public interface Icon

a class that holds the ItemStack to put the given inventory.

Field Summary

Fields

Modifier and Type	Field and Description
static Icon	EMPTY an empty Icon instance.

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.
static @NotNull Icon	cancel(@NotNull org.bukkit.inventory.ItemStack item) creates a simple icon from the given ItemStack with SmartEvent.cancel() interaction.
@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.
static @NotNull Icon	click(@NotNull org.bukkit.inventory.ItemStack item, @NotNull Consumer<ClickEvent> consumer, Predicate<ClickEvent>... requirements) creates a simple icon from the given ItemStack with a ClickEvent.
static @NotNull Icon	drag(@NotNull org.bukkit.inventory.ItemStack item, @NotNull Consumer<DragEvent> consumer, Predicate<DragEvent>... requirements) creates a simple icon from the given ItemStack with a DragEvent.
@NotNull Icon	fallback(@NotNull org.bukkit.inventory.ItemStack fallback) sets the fallback item of the icon to the given item.
static @NotNull Icon	from(@NotNull org.bukkit.inventory.ItemStack item) creates a simple icon from the given ItemStack.
@NotNull org.bukkit.inventory.ItemStack	getItem() obtains the icon's ItemStack.
default <T extends IconEvent> @NotNull Icon	handle(@NotNull Class<T> clazz, @NotNull Consumer<T> consumer, @NotNull List<Predicate<T>> requirements) add the given event and requirements to the icon's handles.
<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.
default @NotNull Icon	whenClick(@NotNull Consumer<ClickEvent> consumer) adds the given ClickEvent to the icon's handles.
default @NotNull Icon	whenClick(@NotNull Consumer<ClickEvent> consumer, @NotNull List<Predicate<ClickEvent>> requirements) adds the given ClickEvent with the requirements to the icon's handles.
default @NotNull Icon	whenDrag(@NotNull Consumer<DragEvent> consumer) adds the given DragEvent to the icon's handles.
default @NotNull Icon	whenDrag(@NotNull Consumer<DragEvent> consumer, @NotNull List<Predicate<DragEvent>> requirements) adds the given DragEvent with the requirements to the icon's handles.
default @NotNull Icon	whenInteract(@NotNull Consumer<IconEvent> consumer) adds the given IconEvent to the icon's handles.
default @NotNull Icon	whenInteract(@NotNull Consumer<IconEvent> consumer, @NotNull List<Predicate<IconEvent>> requirements) adds the given IconEvent with the requirements to the icon's handles.

Field Detail

EMPTY

static final Icon EMPTY

an empty Icon instance.

Method Detail

from

@NotNull
static @NotNull Icon from(@NotNull
                                   @NotNull org.bukkit.inventory.ItemStack item)

creates a simple icon from the given ItemStack.

Parameters:

item - the item to create.

Returns:

a simple icon instance.

click

@SafeVarargs
 @NotNull
static @NotNull Icon click(@NotNull
                                                  @NotNull org.bukkit.inventory.ItemStack item,
                                                  @NotNull
                                                  @NotNull Consumer<ClickEvent> consumer,
                                                  @NotNull
                                                  Predicate<ClickEvent>... requirements)

creates a simple icon from the given ItemStack with a ClickEvent.

Parameters:

item - the item to create.

consumer - the consumer to run.

requirements - the requirements to check.

Returns:

a simple icon instance.

drag

@SafeVarargs
 @NotNull
static @NotNull Icon drag(@NotNull
                                                 @NotNull org.bukkit.inventory.ItemStack item,
                                                 @NotNull
                                                 @NotNull Consumer<DragEvent> consumer,
                                                 @NotNull
                                                 Predicate<DragEvent>... requirements)

creates a simple icon from the given ItemStack with a DragEvent.

Parameters:

item - the item to create.

consumer - the consumer to run.

requirements - the requirements to check.

Returns:

a simple icon instance.

cancel

@NotNull
static @NotNull Icon cancel(@NotNull
                                     @NotNull org.bukkit.inventory.ItemStack item)

creates a simple icon from the given ItemStack with SmartEvent.cancel() interaction.

Parameters:

item - the item to create.

Returns:

a simple icon instance.

whenInteract

@NotNull
default @NotNull Icon whenInteract(@NotNull
                                            @NotNull Consumer<IconEvent> consumer)

adds the given IconEvent to the icon's handles.

Parameters:

consumer - the consumer to add.

Returns:

this, for chained calls.

whenInteract

@NotNull
default @NotNull Icon whenInteract(@NotNull
                                            @NotNull Consumer<IconEvent> consumer,
                                            @NotNull
                                            @NotNull List<Predicate<IconEvent>> requirements)

adds the given IconEvent with the requirements to the icon's handles.

Parameters:

consumer - the consumer to add.

requirements - the requirements to add.

Returns:

this, for chained calls.

whenDrag

@NotNull
default @NotNull Icon whenDrag(@NotNull
                                        @NotNull Consumer<DragEvent> consumer)

adds the given DragEvent to the icon's handles.

Parameters:

consumer - the consumer to add.

Returns:

this, for chained calls.

whenDrag

@NotNull
default @NotNull Icon whenDrag(@NotNull
                                        @NotNull Consumer<DragEvent> consumer,
                                        @NotNull
                                        @NotNull List<Predicate<DragEvent>> requirements)

adds the given DragEvent with the requirements to the icon's handles.

Parameters:

consumer - the consumer to add.

requirements - the requirements to add.

Returns:

this, for chained calls.

whenClick

@NotNull
default @NotNull Icon whenClick(@NotNull
                                         @NotNull Consumer<ClickEvent> consumer)

adds the given ClickEvent to the icon's handles.

Parameters:

consumer - the consumer to add.

Returns:

this, for chained calls.

whenClick

@NotNull
default @NotNull Icon whenClick(@NotNull
                                         @NotNull Consumer<ClickEvent> consumer,
                                         @NotNull
                                         @NotNull List<Predicate<ClickEvent>> requirements)

adds the given ClickEvent with the requirements to the icon's handles.

Parameters:

consumer - the consumer to add.

requirements - the requirements to add.

Returns:

this, for chained calls.

handle

@NotNull
default <T extends IconEvent> @NotNull Icon handle(@NotNull
                                                            @NotNull Class<T> clazz,
                                                            @NotNull
                                                            @NotNull Consumer<T> consumer,
                                                            @NotNull
                                                            @NotNull List<Predicate<T>> requirements)

add the given event and requirements to the icon's handles.

Type Parameters:

T - type of the event.

Parameters:

clazz - the class to determine the type of the event.

consumer - the consumer to add.

requirements - the requirements to add.

Returns:

this, for chained calls.

getItem

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

obtains the icon's ItemStack.

Returns:

the icon's item.

calculateItem

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

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

Parameters:

contents - the contents to calculate.

Returns:

the calculated item.

accept

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

accepts the upcoming event for all of the handles.

Type Parameters:

T - type of the event.

Parameters:

event - the event to accept.

handle

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

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

Type Parameters:

T - type of the event.

Parameters:

handle - the handle to add.

Returns:

this, for chained calls.

handles

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

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

Parameters:

handles - the handles to add.

Returns:

this, for chained calls.

canSee

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

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

Parameters:

predicate - the predicate to set.

Returns:

this, for chained calls.

canUse

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

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

Parameters:

predicate - the predicate to set.

Returns:

this, for chained calls.

fallback

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

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

Parameters:

fallback - the fallback to set.

Returns:

this, for chained calls.

item

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

sets the item of the icon to the given item.

Parameters:

item - the item to set.

Returns:

this, for chained calls.