Class AbstractMenuBuilder<M extends Menu<M>, T extends AbstractMenuBuilder<M,T>>

java.lang.Object

com.kamikazejam.kamicommon.menu.AbstractMenuBuilder<M,T>

Direct Known Subclasses:

OneClickMenu.Builder, PaginatedMenu.Builder, SimpleMenu.Builder

@NonExtendable
public abstract class AbstractMenuBuilder<M extends Menu<M>, T extends AbstractMenuBuilder<M,T>>
extends Object

Do not implement this outside KamiCommon. This was a sealed hierarchy until spigot-utils dropped to Java 8 so that 1.8.x servers could load it; sealed is Java 17 and has no Java 8 spelling. The closed set is still enforced within the library by the verifySealedHierarchies build task, which fails if an implementation appears that is not on the permitted list (SimpleMenu.Builder, PaginatedMenu.Builder, OneClickMenu.Builder). Nothing can enforce it in your code, hence this annotation.

Field Summary

Fields

Modifier and Type	Field	Description
protected final MenuEvents<M>	events
protected final PrioritizedMenuIconMap<M>	menuIcons
protected final MenuOptions<M>	options
protected @NotNull MenuSize	size
protected final @NotNull MenuTitleCalculator	titleCalculator

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMenuBuilder(@NotNull MenuSize size, @NotNull MenuEvents<M> events, @NotNull MenuOptions<M> options)

Method Summary

Modifier and Type	Method	Description
final T	events(@NotNull Consumer<MenuEvents<M>> consumer)
final T	fillerIcon(@Nullable MenuIcon<M> fillerIcon)
final @NotNull MenuSize	getSize()
final T	modifyIcons(@NotNull Consumer<IMenuIconsAccess<M>> consumer)
final T	options(@NotNull Consumer<MenuOptions<M>> consumer)
final T	size(@NotNull MenuSize size)
final T	title(@NotNull ComponentMenuTitleProvider titleProvider)
final T	title(@NotNull MenuTitleProvider titleProvider)	Deprecated. Use title(ComponentMenuTitleProvider) instead to modify parts of the title.
final T	title(@Nullable String title)	Deprecated. Use more specific method titleFromLegacySection(String)
final T	titleFromComponent(@Nullable VersionedComponent title)
final T	titleFromLegacySection(@Nullable String title)
final T	titleFromMiniMessage(@Nullable String title)
final T	titleReplacement(@NotNull CharSequence target, @NotNull CharSequence replacement)

Methods inherited from class Object

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

Field Details

size

@NotNull
protected @NotNull MenuSize size

titleCalculator

@NotNull
protected final @NotNull MenuTitleCalculator titleCalculator

menuIcons

protected final PrioritizedMenuIconMap<M extends Menu<M>> menuIcons

events

protected final MenuEvents<M extends Menu<M>> events

options

protected final MenuOptions<M extends Menu<M>> options

Constructor Details

AbstractMenuBuilder

protected AbstractMenuBuilder(@NotNull
 @NotNull MenuSize size,
 @NotNull
 @NotNull MenuEvents<M> events,
 @NotNull
 @NotNull MenuOptions<M> options)

Method Details

getSize

@NotNull
public final @NotNull MenuSize getSize()

size

@NotNull
public final T size(@NotNull
 @NotNull MenuSize size)

title

@Deprecated
@NotNull
public final T title(@Nullable
 @Nullable String title)

Deprecated.

Use more specific method titleFromLegacySection(String)

titleFromLegacySection

@NotNull
public final T titleFromLegacySection(@Nullable
 @Nullable String title)

titleFromMiniMessage

@NotNull
public final T titleFromMiniMessage(@Nullable
 @Nullable String title)

titleFromComponent

@NotNull
public final T titleFromComponent(@Nullable
 @Nullable VersionedComponent title)

title

@Deprecated
@NotNull
public final T title(@NotNull
 @NotNull MenuTitleProvider titleProvider)

Deprecated.

Use title(ComponentMenuTitleProvider) instead to modify parts of the title.

title

@NotNull
public final T title(@NotNull
 @NotNull ComponentMenuTitleProvider titleProvider)

titleReplacement

@NotNull
public final T titleReplacement(@NotNull
 @NotNull CharSequence target,
 @NotNull
 @NotNull CharSequence replacement)

options

@NotNull
public final T options(@NotNull
 @NotNull Consumer<MenuOptions<M>> consumer)

events

@NotNull
public final T events(@NotNull
 @NotNull Consumer<MenuEvents<M>> consumer)

fillerIcon

@NotNull
public final T fillerIcon(@Nullable
 @Nullable MenuIcon<M> fillerIcon)

modifyIcons

@NotNull
public final T modifyIcons(@NotNull
 @NotNull Consumer<IMenuIconsAccess<M>> consumer)