io.github.portlek.smartinventory.content

Class BasicSlotIterator

java.lang.Object

io.github.portlek.smartinventory.content.BasicSlotIterator

All Implemented Interfaces:

SlotIterator

public final class BasicSlotIterator
extends Object
implements SlotIterator

an implementation for SlotIterator.

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.portlek.smartinventory.SlotIterator

SlotIterator.Type

Constructor Summary

Constructors

Constructor and Description
BasicSlotIterator(@NotNull InventoryContents contents, SlotIterator.Type type) ctor.
BasicSlotIterator(@NotNull InventoryContents contents, SlotIterator.Type type, int startRow, int startColumn) ctor.

Method Summary

Modifier and Type	Method and Description
@NotNull SlotIterator	allowOverride(boolean override) sets the value of the allow override option.
@NotNull SlotIterator	blacklist(int index) blacklists the given slot index.
@NotNull SlotIterator	blacklist(int row, int column) blacklists the given slot position.
@NotNull SlotIterator	blacklistPattern(@NotNull Pattern<Boolean> pattern, int rowOffset, int columnOffset) This method has the inverse effect of SlotIterator.withPattern(Pattern, int, int), where the other method would only allow the iterator to go, this method prohibits this slots to iterate over.
int	column() gets the current column of the iterator.
@NotNull SlotIterator	column(int column) sets the current column of the iterator.
boolean	doesAllowOverride() gets the value of the allow override option.
boolean	ended() checks if this iterator has been ended.
@NotNull SlotIterator	endPosition(int row, int column) sets the slot where the iterator should end.
@NotNull Optional<Icon>	get() gets the icon at the current position in the inventory.
@NotNull SlotIterator	next() moves the cursor to the next position inside the inventory.
@NotNull SlotIterator	previous() moves the cursor to the previous position inside the inventory.
@NotNull SlotIterator	reset() resets iterator to its original position specified while creation.
int	row() gets the current row of the iterator.
@NotNull SlotIterator	row(int row) sets the current row of the iterator.
@NotNull SlotIterator	set(@NotNull Icon icon) replaces the icon at the current position in the inventory by the given icon.
boolean	started() checks if this iterator has been started.
@NotNull SlotIterator	withPattern(@NotNull Pattern<Boolean> pattern, int rowOffset, int columnOffset) setting a pattern using this method will use it as a guideline where the slot iterator can set icons or not.

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

blacklist, blacklistPattern, endPosition, withPattern

Constructor Detail

BasicSlotIterator

public BasicSlotIterator(@NotNull
                         @NotNull InventoryContents contents,
                         @NotNull
                         SlotIterator.Type type)

ctor.

Parameters:

contents - the contents.

type - the type.

BasicSlotIterator

public BasicSlotIterator(@NotNull
                         @NotNull InventoryContents contents,
                         @NotNull
                         SlotIterator.Type type,
                         int startRow,
                         int startColumn)

ctor.

Parameters:

contents - the contents.

type - the type.

startRow - the start row.

startColumn - the start column.

Method Detail

get

@NotNull
public @NotNull Optional<Icon> get()

Description copied from interface: SlotIterator

gets the icon at the current position in the inventory.

Specified by:

get in interface SlotIterator

Returns:

the icon at the current position.

set

@NotNull
public @NotNull SlotIterator set(@NotNull
                                          @NotNull Icon icon)

Description copied from interface: SlotIterator

replaces the icon at the current position in the inventory by the given icon.

Specified by:

set in interface SlotIterator

Parameters:

icon - the new icon.

Returns:

this, for chained calls.

previous

@NotNull
public @NotNull SlotIterator previous()

Description copied from interface: SlotIterator

moves the cursor to the previous position inside the inventory.

this has no effect if the cursor is already at the first position of the inventory.

Specified by:

previous in interface SlotIterator

Returns:

this, for chained calls.

next

@NotNull
public @NotNull SlotIterator next()

Description copied from interface: SlotIterator

moves the cursor to the next position inside the inventory.

this has no effect if the cursor is already at the last position of the inventory.

Specified by:

next in interface SlotIterator

Returns:

this, for chained calls.

blacklist

@NotNull
public @NotNull SlotIterator blacklist(int index)

Description copied from interface: SlotIterator

blacklists the given slot index.

blacklisting a slot will make the iterator skip the given slot and directly go to the next un-blacklisted slot.

Specified by:

blacklist in interface SlotIterator

Parameters:

index - the index to blacklist.

Returns:

this, for chained calls.

blacklist

@NotNull
public @NotNull SlotIterator blacklist(int row,
                                                int column)

Description copied from interface: SlotIterator

blacklists the given slot position.

blacklisting a slot will make the iterator skip the given slot and directly go to the next un-blacklisted slot.

Specified by:

blacklist in interface SlotIterator

Parameters:

row - the row of the slot to blacklist.

column - the column of the slot to blacklist.

Returns:

this, for chained calls.

row

public int row()

Description copied from interface: SlotIterator

gets the current row of the iterator.

Specified by:

row in interface SlotIterator

Returns:

the current row.

row

@NotNull
public @NotNull SlotIterator row(int row)

Description copied from interface: SlotIterator

sets the current row of the iterator.

Specified by:

row in interface SlotIterator

Parameters:

row - the new row.

Returns:

this, for chained calls.

column

public int column()

Description copied from interface: SlotIterator

gets the current column of the iterator.

Specified by:

column in interface SlotIterator

Returns:

the current column.

column

@NotNull
public @NotNull SlotIterator column(int column)

Description copied from interface: SlotIterator

sets the current column of the iterator.

Specified by:

column in interface SlotIterator

Parameters:

column - the new column.

Returns:

this, for chained calls.

reset

@NotNull
public @NotNull SlotIterator reset()

Description copied from interface: SlotIterator

resets iterator to its original position specified while creation.

when the iterator gets reset to its original position, started gets set back to false.

Specified by:

reset in interface SlotIterator

Returns:

this, for chained calls.

started

public boolean started()

Description copied from interface: SlotIterator

checks if this iterator has been started.

an iterator is not started until any of SlotIterator.previous() or SlotIterator.next() methods have been called.

Specified by:

started in interface SlotIterator

Returns:

true if this iterator has been started.

ended

public boolean ended()

Description copied from interface: SlotIterator

checks if this iterator has been ended.

an iterator is not ended until it has reached the last slot of the inventory.

Specified by:

ended in interface SlotIterator

Returns:

true if this iterator has been ended.

endPosition

@NotNull
public @NotNull SlotIterator endPosition(int row,
                                                  int column)

Description copied from interface: SlotIterator

sets the slot where the iterator should end.

if the row is a negative value, it is set to the maximum row count.

if the column is a negative value, it is set to maximum column count.

Specified by:

endPosition in interface SlotIterator

Parameters:

row - the row where the iterator should end.

column - the column where the iterator should end.

Returns:

this, for chained calls.

doesAllowOverride

public boolean doesAllowOverride()

Description copied from interface: SlotIterator

gets the value of the allow override option.

- if this is true, the iterator will override any existing icon it founds on its way.

- if this is false, the iterator will skip the slots which are not empty.

Specified by:

doesAllowOverride in interface SlotIterator

Returns:

true if this iterator allows to override.

allowOverride

@NotNull
public @NotNull SlotIterator allowOverride(boolean override)

Description copied from interface: SlotIterator

sets the value of the allow override option.

- if this is true, the iterator will override any existing icon it founds on its way.

- if this is false, the iterator will skip the slots which are not empty.

Specified by:

allowOverride in interface SlotIterator

Parameters:

override - the value of the allow override option.

Returns:

this, for chained calls.

withPattern

@NotNull
public @NotNull SlotIterator withPattern(@NotNull
                                                  @NotNull Pattern<Boolean> pattern,
                                                  int rowOffset,
                                                  int columnOffset)

Description copied from interface: SlotIterator

setting a pattern using this method will use it as a guideline where the slot iterator can set icons or not. if the pattern doesn't fill the whole inventory, the slot iterator is limited to the space the pattern provides. if the pattern has the wrapAround flag set, then the iterator can iterate over the entire inventory, even if the pattern would not fill it by itself.

the offset defines the top-left corner of the pattern. if the wrapAround flag is set, then the entire pattern will be just shifted by the given amount.

if the provided pattern has no default value set, this method will set it to false.

if you pass null into the pattern parameter, this functionality will be disabled and the iterator will continue to work as normal.

Specified by:

withPattern in interface SlotIterator

Parameters:

pattern - the pattern to use as a guideline.

rowOffset - the row offset from the top left corner.

columnOffset - the column offset from the top left corner.

Returns:

this, for chained calls.

blacklistPattern

@NotNull
public @NotNull SlotIterator blacklistPattern(@NotNull
                                                       @NotNull Pattern<Boolean> pattern,
                                                       int rowOffset,
                                                       int columnOffset)

Description copied from interface: SlotIterator

This method has the inverse effect of SlotIterator.withPattern(Pattern, int, int), where the other method would only allow the iterator to go, this method prohibits this slots to iterate over.

Specified by:

blacklistPattern in interface SlotIterator

Parameters:

pattern - the pattern where the slot iterator cannot iterate.

rowOffset - the row offset from the top left corner.

columnOffset - the column offset from the top left corner.

Returns:

this, for chained calls.