me.lucko.helper.menu.scheme

Interface SchemeMapping

All Known Implementing Classes:

AbstractSchemeMapping, FunctionalSchemeMapping

public interface SchemeMapping

Represents a mapping to be used in a MenuScheme

Method Summary

Modifier and Type	Method and Description
SchemeMapping	copy() Makes a copy of this scheme mapping.
default Optional<Item>	get(int key) Gets an item from the mapping which represents the given key.
Item	getNullable(int key) Gets an item from the mapping which represents the given key.
boolean	hasMappingFor(int key) Gets if this scheme has a mapping for a given key

Method Detail

get

@Nonnull
default Optional<Item> get(int key)

Gets an item from the mapping which represents the given key.

Parameters:

key - the mapping key

Returns:

an item if present, otherwise an empty optional

getNullable

@Nullable
Item getNullable(int key)

Gets an item from the mapping which represents the given key.

Parameters:

key - the mapping key

Returns:

an item if present, otherwise null

hasMappingFor

boolean hasMappingFor(int key)

Gets if this scheme has a mapping for a given key

Parameters:

key - the mapping key

Returns:

true if the scheme has a mapping for the key

copy

@Nonnull
SchemeMapping copy()

Makes a copy of this scheme mapping.

Returns:

a copy of this mapping.