io.github.portlek.smartinventory.content

Class BasicInventoryContents

java.lang.Object

io.github.portlek.smartinventory.content.BasicInventoryContents

All Implemented Interfaces:

InventoryContents

public final class BasicInventoryContents
extends Object
implements InventoryContents

an implementation for InventoryContents.

Constructor Summary

Constructors

Constructor and Description
BasicInventoryContents(@NotNull Page page, @NotNull org.bukkit.entity.Player player) ctor.
BasicInventoryContents(@NotNull Page page, @NotNull org.bukkit.entity.Player player, @NotNull Icon[][] contents) ctpr.

Method Summary

Modifier and Type	Method and Description
@NotNull Icon[][]	all() returns a 2D array of Icon containing all the items of the inventory.
<T> T	getProperty(@NotNull String name) gets the value of the property with the given name.
<T> T	getPropertyOrDefault(@NotNull String name, T def) gets the value of the property with the given name, or a default value if the property isn't set.
boolean	isEditable(@NotNull SlotPos slot) returns if a given slot is editable or not.
@NotNull Optional<SlotIterator>	iterator(@NotNull String id) gets a previously registered iterator named with the given id.
@NotNull SlotIterator	newIterator(@NotNull String id, SlotIterator.Type type, int startRow, int startColumn) creates and registers an iterator using a given id.
@NotNull Page	page() obtains the page of the this.
@NotNull Pagination	pagination() gets the pagination system linked to this.
@NotNull org.bukkit.entity.Player	player() obtains the player of the contents.
@NotNull InventoryContents	set(int row, int column, @Nullable Icon item) same as InventoryContents.set(int, Icon), but with a row and a column instead of the index.
@NotNull InventoryContents	setEditable(@NotNull SlotPos slot, boolean editable) makes a slot editable, which enables the player to put items in and take items out of the inventory in the specified slot.
@NotNull InventoryContents	setProperty(@NotNull String name, @NotNull Object value) sets the value of the property with the given name.

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.InventoryContents

add, applyRect, applyRect, fill, fillBorders, fillColumn, fillEmpties, fillPattern, fillPattern, fillPattern, fillPattern, fillPatternRepeating, fillPatternRepeating, fillPatternRepeating, fillPatternRepeating, fillRect, fillRect, fillRect, fillRow, fillSquare, fillSquare, fillSquare, findItem, findItem, firstEmpty, get, get, get, getBottomInventory, getTopInventory, newIterator, newIterator, newIterator, notifyUpdate, notifyUpdateForAll, notifyUpdateForAllById, openNext, openPrevious, removeAll, removeAll, removeAmount, removeAmount, removeFirst, removeFirst, reopen, set, set, setEditable, slots

Constructor Detail

BasicInventoryContents

public BasicInventoryContents(@NotNull
                              @NotNull Page page,
                              @NotNull
                              @NotNull org.bukkit.entity.Player player,
                              @NotNull
                              @NotNull Icon[][] contents)

ctpr.

Parameters:

page - the page.

player - the player.

contents - the contents.

BasicInventoryContents

public BasicInventoryContents(@NotNull
                              @NotNull Page page,
                              @NotNull
                              @NotNull org.bukkit.entity.Player player)

ctor.

Parameters:

page - the page.

player - the player

Method Detail

page

@NotNull
public @NotNull Page page()

Description copied from interface: InventoryContents

obtains the page of the this.

Specified by:

page in interface InventoryContents

Returns:

a page instance.

pagination

@NotNull
public @NotNull Pagination pagination()

Description copied from interface: InventoryContents

gets the pagination system linked to this.

Specified by:

pagination in interface InventoryContents

Returns:

the pagination

all

@NotNull
public @NotNull Icon[][] all()

Description copied from interface: InventoryContents

returns a 2D array of Icon containing all the items of the inventory.

the Icons can be null when there is no item in the corresponding slot.

Specified by:

all in interface InventoryContents

Returns:

the items of the inventory.

player

@NotNull
public @NotNull org.bukkit.entity.Player player()

Description copied from interface: InventoryContents

obtains the player of the contents.

Specified by:

player in interface InventoryContents

Returns:

the player instance.

iterator

@NotNull
public @NotNull Optional<SlotIterator> iterator(@NotNull
                                                         @NotNull String id)

Description copied from interface: InventoryContents

gets a previously registered iterator named with the given id.

if no iterator is found, this will return Optional.empty().

Specified by:

iterator in interface InventoryContents

Parameters:

id - the id of the iterator.

Returns:

the found iterator, if there is one.

getProperty

@Nullable
public <T> T getProperty(@NotNull
                                   @NotNull String name)

Description copied from interface: InventoryContents

gets the value of the property with the given name.

Specified by:

getProperty in interface InventoryContents

Type Parameters:

T - the type of the value.

Parameters:

name - the property's name.

Returns:

the property's value.

getPropertyOrDefault

@NotNull
public <T> T getPropertyOrDefault(@NotNull
                                           @NotNull String name,
                                           @NotNull
                                           T def)

Description copied from interface: InventoryContents

gets the value of the property with the given name, or a default value if the property isn't set.

Specified by:

getPropertyOrDefault in interface InventoryContents

Type Parameters:

T - the type of the value.

Parameters:

name - the property's name.

def - the default value.

Returns:

the property's value, or the given default value.

newIterator

@NotNull
public @NotNull SlotIterator newIterator(@NotNull
                                                  @NotNull String id,
                                                  @NotNull
                                                  SlotIterator.Type type,
                                                  int startRow,
                                                  int startColumn)

Description copied from interface: InventoryContents

creates and registers an iterator using a given id.

you can retrieve the iterator at any time using the InventoryContents.iterator(String) method.

Specified by:

newIterator in interface InventoryContents

Parameters:

id - the id of the iterator.

type - the type of the iterator.

startRow - the starting row of the iterator.

startColumn - the starting column of the iterator.

Returns:

the newly created iterator.

set

@NotNull
public @NotNull InventoryContents set(int row,
                                               int column,
                                               @Nullable
                                               @Nullable Icon item)

Description copied from interface: InventoryContents

same as InventoryContents.set(int, Icon), but with a row and a column instead of the index.

Specified by:

set in interface InventoryContents

Parameters:

row - the row to set.

column - the column to set.

item - the item to set.

Returns:

this, for chained calls.

setProperty

@NotNull
public @NotNull InventoryContents setProperty(@NotNull
                                                       @NotNull String name,
                                                       @NotNull
                                                       @NotNull Object value)

Description copied from interface: InventoryContents

sets the value of the property with the given name.

this will replace the existing value for the property, if there is one.

Specified by:

setProperty in interface InventoryContents

Parameters:

name - the property's name.

value - the new property's value.

Returns:

this, for chained calls.

setEditable

@NotNull
public @NotNull InventoryContents setEditable(@NotNull
                                                       @NotNull SlotPos slot,
                                                       boolean editable)

Description copied from interface: InventoryContents

makes a slot editable, which enables the player to put items in and take items out of the inventory in the specified slot.

Specified by:

setEditable in interface InventoryContents

Parameters:

slot - the slot to set editable.

editable - true to make a slot editable, false to make it 'static' again.

Returns:

this, for chained calls.

isEditable

public boolean isEditable(@NotNull
                          @NotNull SlotPos slot)

Description copied from interface: InventoryContents

returns if a given slot is editable or not.

Specified by:

isEditable in interface InventoryContents

Parameters:

slot - The slot to check.

Returns:

true if the editable.