Class MenuIconsAccess<M extends Menu<M>>

java.lang.Object

com.kamikazejam.kamicommon.menu.api.icons.access.MenuIconsAccess<M>

All Implemented Interfaces:

IMenuIconsAccess<M>

public class MenuIconsAccess<M extends Menu<M>>
extends Object
implements IMenuIconsAccess<M>

Constructor Summary

Constructors

Constructor	Description
MenuIconsAccess(@NotNull MenuSize menuSize, @NotNull PrioritizedMenuIconMap<M> menuIcons)

Method Summary

Modifier and Type	Method	Description
void	clearMenuIcons()
@NotNull Optional<MenuIcon<M>>	getMenuIcon(int slot)	Retrieve a MenuIcon by a slot number.
@NotNull Optional<MenuIcon<M>>	getMenuIcon(@NotNull PositionIconSlot slot)	Retrieve a MenuIcon by a position.
@NotNull Optional<MenuIcon<M>>	getMenuIcon(@NotNull String id)	Retrieve a MenuIcon by its id
@NotNull Set<String>	getMenuIconIDs()
boolean	hasMenuIcon(int slot)
boolean	hasMenuIcon(@NotNull PositionIconSlot slot)
boolean	isValidMenuIconID(@NotNull String id)
@Nullable Set<MenuIcon<M>>	removeMenuIcon(int slot)
@Nullable MenuIcon<M>	removeMenuIcon(@NotNull String id)
@NotNull MenuIcon<M>	setMenuIcon(@NotNull MenuIcon<M> menuIcon, @Nullable IconSlot iconSlot)

Methods inherited from class Object

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

Methods inherited from interface IMenuIconsAccess

getMenuIcon, hasMenuIcon, setAutoUpdate, setAutoUpdate, setMenuClick, setMenuIcon, setMenuIcon, setMenuIcon, setMenuIcon, setMenuIcon, setMenuIcon, setMenuIcon, setMenuIcon, setMenuIcon, setMenuIcon, setMenuIcon, setMenuIcon, setMenuIcon, setMenuIcon, setMenuIcon, setMenuIcon, setMenuIcon, setModifier, setModifier

Constructor Details

MenuIconsAccess

public MenuIconsAccess(@NotNull
 @NotNull MenuSize menuSize,
 @NotNull
 @NotNull PrioritizedMenuIconMap<M> menuIcons)

Method Details

setMenuIcon

@NotNull
public @NotNull MenuIcon<M> setMenuIcon(@NotNull
 @NotNull MenuIcon<M> menuIcon,
 @Nullable
 @Nullable IconSlot iconSlot)

Specified by:

setMenuIcon in interface IMenuIconsAccess<M extends Menu<M>>

removeMenuIcon

@Nullable
public @Nullable MenuIcon<M> removeMenuIcon(@NotNull
 @NotNull String id)

Specified by:

removeMenuIcon in interface IMenuIconsAccess<M extends Menu<M>>

removeMenuIcon

@Nullable
public @Nullable Set<MenuIcon<M>> removeMenuIcon(int slot)

Specified by:

removeMenuIcon in interface IMenuIconsAccess<M extends Menu<M>>

clearMenuIcons

public void clearMenuIcons()

Specified by:

clearMenuIcons in interface IMenuIconsAccess<M extends Menu<M>>

getMenuIcon

@NotNull
public @NotNull Optional<MenuIcon<M>> getMenuIcon(@NotNull
 @NotNull String id)

Description copied from interface: IMenuIconsAccess

Retrieve a MenuIcon by its id

Specified by:

getMenuIcon in interface IMenuIconsAccess<M extends Menu<M>>

isValidMenuIconID

public boolean isValidMenuIconID(@NotNull
 @NotNull String id)

Specified by:

isValidMenuIconID in interface IMenuIconsAccess<M extends Menu<M>>

getMenuIconIDs

@NotNull
public @NotNull Set<String> getMenuIconIDs()

Specified by:

getMenuIconIDs in interface IMenuIconsAccess<M extends Menu<M>>

getMenuIcon

@NotNull
public @NotNull Optional<MenuIcon<M>> getMenuIcon(int slot)

Description copied from interface: IMenuIconsAccess

Retrieve a MenuIcon by a slot number. If the filler MenuIcon has been configured and is enabled, it will be returned if no other MenuIcon is found for the slot.

Specified by:

getMenuIcon in interface IMenuIconsAccess<M extends Menu<M>>

hasMenuIcon

public boolean hasMenuIcon(int slot)

Specified by:

hasMenuIcon in interface IMenuIconsAccess<M extends Menu<M>>

getMenuIcon

@NotNull
public @NotNull Optional<MenuIcon<M>> getMenuIcon(@NotNull
 @NotNull PositionIconSlot slot)

Description copied from interface: IMenuIconsAccess

Retrieve a MenuIcon by a position. If the filler MenuIcon has been configured and is enabled, it will be returned if no other MenuIcon is found for the position.

Specified by:

getMenuIcon in interface IMenuIconsAccess<M extends Menu<M>>

Parameters:

slot - The position slot

hasMenuIcon

public boolean hasMenuIcon(@NotNull
 @NotNull PositionIconSlot slot)

Specified by:

hasMenuIcon in interface IMenuIconsAccess<M extends Menu<M>>

Parameters:

slot - The position slot