pro.zackpollard.telegrambot.api.menu

Class AbstractInlineMenuBuilder<T extends AbstractInlineMenuBuilder>

java.lang.Object

pro.zackpollard.telegrambot.api.menu.AbstractInlineMenuBuilder<T>

Type Parameters:

T - Implementing class

Direct Known Subclasses:

InlineMenuBuilder, SubInlineMenuBuilder

public abstract class AbstractInlineMenuBuilder<T extends AbstractInlineMenuBuilder>
extends Object

Abstract menu builder, shared methods between sub menus and head menus. Supports rows and user predicates.

Author:

Mazen Kotb

Constructor Summary

Constructors

Constructor and Description
AbstractInlineMenuBuilder()

Method Summary

Modifier and Type	Method and Description
T	allowedUser(long userId) Allow a single user to use this menu
T	allowedUser(User allowedUser) Allow a single user to use this menu
T	allowedUsers(long... userIds) Allow a list of users to use this menu
T	allowedUsers(User... users) Allow a list of users to use this menu
abstract InlineMenu	buildMenu() Build the menu
protected InlineMenu	buildMenu(Message base) Build a menu from message base.
protected abstract T	instance() Return current instance.
InlineMenuRowBuilder<T>	newRow() Create a new row
T	removeLast() Remove the last row.
T	userFilter(Predicate<User> predicate) Add a user filter to the menu.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractInlineMenuBuilder

public AbstractInlineMenuBuilder()

Method Detail

newRow

public InlineMenuRowBuilder<T> newRow()

Create a new row

Returns:

new row builder

buildMenu

public abstract InlineMenu buildMenu()

Build the menu

Returns:

Built menu

instance

protected abstract T instance()

Return current instance. Used for non-abstract builder methods

Returns:

'this'

buildMenu

protected InlineMenu buildMenu(Message base)

Build a menu from message base. Adds & Registers all buttons. Applies user predicate. Applies rows.

Parameters:

base - Message

Returns:

built menu

removeLast

public T removeLast()

Remove the last row.

Returns:

this

userFilter

public T userFilter(Predicate<User> predicate)

Add a user filter to the menu. Predicate is called before any buttons are called, if returned true the button will be called, otherwise it won't

Parameters:

predicate - user filter

Returns:

this

allowedUsers

public T allowedUsers(User... users)

Allow a list of users to use this menu

Parameters:

users - Allowed users

Returns:

this

allowedUser

public T allowedUser(User allowedUser)

Allow a single user to use this menu

Parameters:

allowedUser - allowed user

Returns:

this

allowedUsers

public T allowedUsers(long... userIds)

Allow a list of users to use this menu

Parameters:

userIds - allows user ids

Returns:

this

allowedUser

public T allowedUser(long userId)

Allow a single user to use this menu

Parameters:

userId - the id of said user

Returns:

this