me.lucko.helper.menu.scheme

Class MenuPopulator

java.lang.Object

me.lucko.helper.menu.scheme.MenuPopulator

@NonnullByDefault
public class MenuPopulator
extends Object

A utility to help place items into a Gui

Field Summary

Fields

Modifier and Type	Field and Description
protected List<Integer>	remainingSlots

Constructor Summary

Constructors

Constructor and Description
MenuPopulator(Gui gui, List<Integer> slots)
MenuPopulator(Gui gui, MenuScheme scheme)

Method Summary

Modifier and Type	Method and Description
MenuPopulator	accept(Item item) Places an item onto the Gui using the next available slot in the populator
MenuPopulator	acceptIfSpace(Item item) Places an item onto the Gui using the next available slot in the populator
MenuPopulator	consume(Consumer<Slot> action)
MenuPopulator	consumeIfSpace(Consumer<Slot> action)
MenuPopulator	copy()
int	getRemainingSpace() Gets the number of remaining slots in the populator.
ImmutableList<Integer>	getSlots() Gets an immutable copy of the slots used by this populator.
boolean	hasSpace() Gets if there is any space left in this populator
boolean	placeIfSpace(Item item) Places an item onto the Gui using the next available slot in the populator
void	reset() Resets the slot order used by this populator to the state it was in upon construction
boolean	tryConsume(Consumer<Slot> action)

Methods inherited from class java.lang.Object

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

Field Detail

remainingSlots

protected List<Integer> remainingSlots

Constructor Detail

MenuPopulator

public MenuPopulator(Gui gui,
                     MenuScheme scheme)

MenuPopulator

public MenuPopulator(Gui gui,
                     List<Integer> slots)

Method Detail

getSlots

public ImmutableList<Integer> getSlots()

Gets an immutable copy of the slots used by this populator.

Returns:

the slots used by this populator.

reset

public void reset()

Resets the slot order used by this populator to the state it was in upon construction

consume

public MenuPopulator consume(Consumer<Slot> action)

consumeIfSpace

public MenuPopulator consumeIfSpace(Consumer<Slot> action)

tryConsume

public boolean tryConsume(Consumer<Slot> action)

accept

public MenuPopulator accept(Item item)

Places an item onto the Gui using the next available slot in the populator

Parameters:

item - the item to place

Returns:

the populator

Throws:

IllegalStateException - if there are not more slots

acceptIfSpace

public MenuPopulator acceptIfSpace(Item item)

Places an item onto the Gui using the next available slot in the populator

Parameters:

item - the item to place

Returns:

the populator

placeIfSpace

public boolean placeIfSpace(Item item)

Places an item onto the Gui using the next available slot in the populator

Parameters:

item - the item to place

Returns:

true if there was a slot left in the populator to place this item onto, false otherwise

getRemainingSpace

public int getRemainingSpace()

Gets the number of remaining slots in the populator.

Returns:

the number of remaining slots

hasSpace

public boolean hasSpace()

Gets if there is any space left in this populator

Returns:

if there is more space

copy

public MenuPopulator copy()