Index (Pagination Utils 4.0.2b API)

A B C D E F G I L M N O P R S T V W
All Classes|All Packages|Serialized Form

A

accept(A) - Method in interface com.github.ygimenez.model.ThrowingConsumer
accept(A, B) - Method in interface com.github.ygimenez.model.ThrowingBiConsumer
accept(A, Pair<B, C>) - Method in interface com.github.ygimenez.model.ThrowingTriConsumer
ACCEPT - Enum constant in enum com.github.ygimenez.type.Emote: Emote representing the "accept" button (default: ✅).
acceptThrows(A) - Method in interface com.github.ygimenez.model.ThrowingConsumer: Performs this operation on the given arguments.
acceptThrows(A, B) - Method in interface com.github.ygimenez.model.ThrowingBiConsumer: Performs this operation on the given arguments.
acceptThrows(A, B, C) - Method in interface com.github.ygimenez.model.ThrowingTriConsumer: Performs this operation on the given arguments.
ActionReference - Class in com.github.ygimenez.model: Class used for checking whether a library action (read: paginate, categorize, buttonize or lazy-paginate action) was already disposed of.
ActionReference(String) - Constructor for class com.github.ygimenez.model.ActionReference: Creates a new ActionReference for tracking a specific event key.
activate() - Method in class com.github.ygimenez.model.PaginatorBuilder: Utility terminal operation that builds the Paginator and activates it.
activate(Paginator) - Static method in class com.github.ygimenez.method.Pages: Set a Paginator object to handle incoming events.
addAction(Emoji, ThrowingConsumer<ButtonWrapper>) - Method in class com.github.ygimenez.model.helper.ButtonizeHelper: Adds a new button to the map.
addCategory(Emoji, Page) - Method in class com.github.ygimenez.model.helper.CategorizeHelper: Adds a new category to the map.
addEvent(Message, ThrowingBiConsumer<User, PaginationEventWrapper>) - Method in class com.github.ygimenez.listener.MessageHandler: Adds an event to the handler, which will be executed whenever a button with the same ID is pressed.
addPage(Page) - Method in class com.github.ygimenez.model.helper.LazyPaginateHelper: Adds a new page to the list.
addPage(Page) - Method in class com.github.ygimenez.model.helper.PaginateHelper: Adds a new page to the list.
addReactions(Message, boolean, boolean) - Static method in class com.github.ygimenez.method.Pages: Utility method to add navigation buttons.
AlreadyActivatedException - Exception in com.github.ygimenez.exception: Exception thrown when the library has already been activated.
AlreadyActivatedException() - Constructor for exception com.github.ygimenez.exception.AlreadyActivatedException: Default constructor.
AlreadyAssignedException - Exception in com.github.ygimenez.exception: Exception thrown when trying to add an emote already assigned.
AlreadyAssignedException() - Constructor for exception com.github.ygimenez.exception.AlreadyAssignedException: Default constructor.
apply(Out) - Method in class com.github.ygimenez.model.helper.BaseHelper: Prepares the message for being used by the library.
apply(T) - Method in interface com.github.ygimenez.model.ThrowingFunction
applyThrows(T) - Method in interface com.github.ygimenez.model.ThrowingFunction: Performs this operation on the given arguments.

B

BaseHelper<Helper extends BaseHelper<Helper,T>,T> - Class in com.github.ygimenez.model.helper: Abstract class meant to be extended by builder-like classes, allowing reusability of parameters passed to Pages methods.
BaseHelper(Class<Helper>, T, boolean) - Constructor for class com.github.ygimenez.model.helper.BaseHelper: Constructor for BaseHelper.
build() - Method in class com.github.ygimenez.model.PaginatorBuilder: Finishes building the Paginator instance, locking further modifications.
buttonize(Message, ButtonizeHelper) - Static method in class com.github.ygimenez.method.Pages: Adds buttons to the specified Message/MessageEmbed, with each executing a specific task on click.
buttonize(Message, Map<Emoji, ThrowingConsumer<ButtonWrapper>>, boolean, boolean) - Static method in class com.github.ygimenez.method.Pages: Adds buttons to the specified Message/MessageEmbed, with each executing a specific task on click.
buttonize(Message, Map<Emoji, ThrowingConsumer<ButtonWrapper>>, boolean, boolean, int, TimeUnit) - Static method in class com.github.ygimenez.method.Pages: Adds buttons to the specified Message/MessageEmbed, with each executing a specific task on click.
buttonize(Message, Map<Emoji, ThrowingConsumer<ButtonWrapper>>, boolean, boolean, int, TimeUnit, Predicate<User>) - Static method in class com.github.ygimenez.method.Pages: Adds buttons to the specified Message/MessageEmbed, with each executing a specific task on click.
buttonize(Message, Map<Emoji, ThrowingConsumer<ButtonWrapper>>, boolean, boolean, int, TimeUnit, Predicate<User>, Consumer<Message>) - Static method in class com.github.ygimenez.method.Pages: Adds buttons to the specified Message/MessageEmbed, with each executing a specific task on click.
buttonize(Message, Map<Emoji, ThrowingConsumer<ButtonWrapper>>, boolean, boolean, Predicate<User>) - Static method in class com.github.ygimenez.method.Pages: Adds buttons to the specified Message/MessageEmbed, with each executing a specific task on click.
buttonize(Message, Map<Emoji, ThrowingConsumer<ButtonWrapper>>, boolean, boolean, Predicate<User>, Consumer<Message>) - Static method in class com.github.ygimenez.method.Pages: Adds buttons to the specified Message/MessageEmbed, with each executing a specific task on click.
ButtonizeHelper - Class in com.github.ygimenez.model.helper: Helper class for building buttonize events, safe for reuse.
ButtonizeHelper(boolean) - Constructor for class com.github.ygimenez.model.helper.ButtonizeHelper: Creates a new buttonize event helper with the default map implementation (LinkedHashMap).
ButtonizeHelper(Map<Emoji, ThrowingConsumer<ButtonWrapper>>, boolean) - Constructor for class com.github.ygimenez.model.helper.ButtonizeHelper: Creates a new buttonize event helper with the supplied map.
ButtonWrapper - Class in com.github.ygimenez.model: Wrapper for Pages.buttonize(net.dv8tion.jda.api.entities.Message, java.util.Map<net.dv8tion.jda.api.entities.emoji.Emoji, com.github.ygimenez.model.ThrowingConsumer<com.github.ygimenez.model.ButtonWrapper>>, boolean, boolean) arguments containing necessary data for processing.
ButtonWrapper(User, InteractionHook, Button, Message) - Constructor for class com.github.ygimenez.model.ButtonWrapper: Constructs a new ButtonWrapper instance.

C

CANCEL - Enum constant in enum com.github.ygimenez.type.Emote: Emote representing the "cancel" button (default: ❎).
canInteract(User) - Method in class com.github.ygimenez.model.helper.BaseHelper: Checks whether the supplied User can interact with the event.
categorize(Message, CategorizeHelper) - Static method in class com.github.ygimenez.method.Pages: Adds menu-like buttons to the specified Message/MessageEmbed which will browse through a given Map of pages.
categorize(Message, Map<Emoji, Page>, boolean) - Static method in class com.github.ygimenez.method.Pages: Adds menu-like buttons to the specified Message/MessageEmbed which will browse through a given Map of pages.
categorize(Message, Map<Emoji, Page>, boolean, int, TimeUnit) - Static method in class com.github.ygimenez.method.Pages: Adds menu-like buttons to the specified Message/MessageEmbed which will browse through a given Map of pages.
categorize(Message, Map<Emoji, Page>, boolean, int, TimeUnit, Predicate<User>) - Static method in class com.github.ygimenez.method.Pages: Adds menu-like buttons to the specified Message/MessageEmbed which will browse through a given Map of pages.
categorize(Message, Map<Emoji, Page>, boolean, Predicate<User>) - Static method in class com.github.ygimenez.method.Pages: Adds menu-like buttons to the specified Message/MessageEmbed which will browse through a given Map of pages.
CategorizeHelper - Class in com.github.ygimenez.model.helper: Helper class for building categorize events, safe for reuse.
CategorizeHelper(boolean) - Constructor for class com.github.ygimenez.model.helper.CategorizeHelper: Creates a new categorize event helper with the default map implementation (LinkedHashMap).
CategorizeHelper(Map<Emoji, Page>, boolean) - Constructor for class com.github.ygimenez.model.helper.CategorizeHelper: Creates a new categorize event helper with the supplied map.
check() - Method in class com.github.ygimenez.model.ActionReference: Utility method to check whether the referred action is still active.
checkEvent(String) - Method in class com.github.ygimenez.listener.MessageHandler: Checks if an event hash is still present in the map.
clear() - Method in class com.github.ygimenez.listener.MessageHandler: Purge events map.

WARNING: This will break all active pagination, use with caution.
clearButtons(Message) - Static method in class com.github.ygimenez.method.Pages: Utility method to clear all buttons of a message.
clearReactions(Message) - Static method in class com.github.ygimenez.method.Pages: Utility method to clear all reactions of a message.
com.github.ygimenez.exception - package com.github.ygimenez.exception
com.github.ygimenez.listener - package com.github.ygimenez.listener
com.github.ygimenez.method - package com.github.ygimenez.method
com.github.ygimenez.model - package com.github.ygimenez.model
com.github.ygimenez.model.helper - package com.github.ygimenez.model.helper
com.github.ygimenez.type - package com.github.ygimenez.type
createPaginator() - Static method in class com.github.ygimenez.model.PaginatorBuilder: Creates a new PaginatorBuilder instance and begin customization, use PaginatorBuilder.build() to finish.
createPaginator(JDA) - Static method in class com.github.ygimenez.model.PaginatorBuilder: Creates a new PaginatorBuilder instance and begin customization, use PaginatorBuilder.build() to finish.
createPaginator(ShardManager) - Static method in class com.github.ygimenez.model.PaginatorBuilder: Creates a new PaginatorBuilder instance and begin customization, use PaginatorBuilder.build() to finish.
createSimplePaginator(JDA) - Static method in class com.github.ygimenez.model.PaginatorBuilder: Creates a new Paginator instance using default settings.
createSimplePaginator(ShardManager) - Static method in class com.github.ygimenez.model.PaginatorBuilder: Creates a new Paginator instance using default settings.

D

deactivate() - Static method in class com.github.ygimenez.method.Pages: Removes current button handler, allowing another Pages.activate(Paginator) call.

Using this method without activating beforehand will do nothing.

E

Emote - Enum in com.github.ygimenez.type: Enumerator representing values required by non-dynamic buttons.

F

finalizeEvent(Message, Consumer<Void>) - Static method in class com.github.ygimenez.method.Pages: Utility method to clear all reactions of a message.
finishEmotes() - Method in class com.github.ygimenez.model.Paginator: Make configured Emotes final.
fromButton(Button) - Static method in enum com.github.ygimenez.type.Emote: Returns the Emote represented by the supplied Button, if any.

G

get() - Method in class com.github.ygimenez.model.ActionReference: Retrieves the referred action key if it is still active, or null otherwise.
getButton() - Method in class com.github.ygimenez.model.ButtonWrapper: Retrieves the Button that triggered the event.
getByEmoji(Emoji) - Static method in enum com.github.ygimenez.type.Emote: Retrieves the Emote linked to supplied Emoji.
getCaptions() - Method in class com.github.ygimenez.model.InteractPage: Retrieves current Map of Button captions.
getChannel() - Method in class com.github.ygimenez.model.ButtonWrapper: Shortcut for retrieving the Message's MessageChannel.
getComponents(Out) - Method in class com.github.ygimenez.model.helper.BaseHelper: Retrieves the List of Components generated by this helper.
getComponents(Out) - Method in class com.github.ygimenez.model.helper.ButtonizeHelper
getComponents(Out) - Method in class com.github.ygimenez.model.helper.CategorizeHelper
getComponents(Out) - Method in class com.github.ygimenez.model.helper.LazyPaginateHelper
getComponents(Out) - Method in class com.github.ygimenez.model.helper.PaginateHelper
getContent() - Method in class com.github.ygimenez.model.helper.BaseHelper: Retrieves the collection used by this helper to store the pages.
getContent() - Method in class com.github.ygimenez.model.Page: Method to get this Page's content object.
getContent() - Method in class com.github.ygimenez.model.PaginationEventWrapper: Retrieves the button which triggered the event.
getDefault() - Method in enum com.github.ygimenez.type.Emote: Retrieves this Emote's default Emoji.
getEmoji(Emote) - Method in class com.github.ygimenez.model.Paginator: Retrieves the Emoji assigned to the supplied Emote.
getEmote(Emote) - Method in class com.github.ygimenez.model.PaginatorBuilder: Retrieves an Emote's code from the current emote Map.
getEmotes() - Method in class com.github.ygimenez.model.Paginator: The Map containing configured Emotes for this Paginator.
getEventMap() - Method in class com.github.ygimenez.listener.MessageHandler: Retrieves the event handler map.
getHandler() - Static method in class com.github.ygimenez.method.Pages: Retrieves the library's MessageHandler object.
getHandler() - Method in class com.github.ygimenez.model.Paginator: Retrieves the handler used during this Paginator's construction.
getHandler() - Method in class com.github.ygimenez.model.PaginatorBuilder: Retrieve the configured handler for this PaginatorBuilder instance.
getHook() - Method in class com.github.ygimenez.model.ButtonWrapper: Retrieves the event's InteractionHook.
getId(Emoji) - Static method in enum com.github.ygimenez.type.Emote: Utility method for retrieving an Emoji's effective ID.
getLogger() - Method in class com.github.ygimenez.model.Paginator: Retrieves Logger instance used by the library.
getLogLevel() - Static method in class com.github.ygimenez.model.PUtilsConfig: Retrieves the PUtilsConfig.LogLevel currently configured.
getMember() - Method in class com.github.ygimenez.model.ButtonWrapper: Retrieves the Member who pressed the button.
getMessage() - Method in class com.github.ygimenez.model.ButtonWrapper: Retrieves the parent Message.
getMessageId() - Method in class com.github.ygimenez.model.PaginationEventWrapper: Retrieves the Message ID.
getOnFinalization() - Method in class com.github.ygimenez.model.helper.ButtonizeHelper: Retrieves the Consumer that'll be executed when the event ends.
getOnRemove() - Static method in class com.github.ygimenez.model.PUtilsConfig: Retrieve the action performed when encounteing an unmapped event.
getPageLoader() - Method in class com.github.ygimenez.model.helper.LazyPaginateHelper: Retrieves the configured page loader for this helper.
getPaginator() - Static method in class com.github.ygimenez.method.Pages: Retrieves the Paginator object used to activate this library.
getSkipAmount() - Method in class com.github.ygimenez.model.helper.PaginateHelper: Retrieves the configured amount of pages to be skipped on pressing Emote.SKIP_BACKWARD or Emote.SKIP_FORWARD.
getSource() - Method in class com.github.ygimenez.model.PaginationEventWrapper: Retrieves source event.
getStyle() - Method in enum com.github.ygimenez.type.Emote: Retrieves this Emote's ButtonStyle.
getStyles() - Method in class com.github.ygimenez.model.InteractPage: Retrieves current Map of Button style overrides.
getTimeout() - Method in class com.github.ygimenez.model.helper.BaseHelper: Retrieves the timeout for the event, in milliseconds.
getUser() - Method in class com.github.ygimenez.model.ButtonWrapper: Retrieves the User who pressed the button.
getUser() - Method in class com.github.ygimenez.model.PaginationEventWrapper: Retrieves the User who pressed the button.
GOTO_FIRST - Enum constant in enum com.github.ygimenez.type.Emote: Emote representing the "go to first" button (default: ⏮).
GOTO_LAST - Enum constant in enum com.github.ygimenez.type.Emote: Emote representing the "go to last" button (default: ⏭).

I

InteractPage - Class in com.github.ygimenez.model: Class representing either a Message or MessageEmbed object.
InteractPage(Object) - Constructor for class com.github.ygimenez.model.InteractPage: An InteractPage object to be used in this library's methods.
InvalidGuildException - Exception in com.github.ygimenez.exception: Exception thrown when trying to set an invalid lookup guild.
InvalidGuildException() - Constructor for exception com.github.ygimenez.exception.InvalidGuildException: Default constructor.
InvalidHandlerException - Exception in com.github.ygimenez.exception: Exception thrown when trying to set an invalid handler (not JDA or ShardManager).
InvalidHandlerException() - Constructor for exception com.github.ygimenez.exception.InvalidHandlerException: Default constructor.
InvalidStateException - Exception in com.github.ygimenez.exception: Exception thrown when no handler has been set.
InvalidStateException() - Constructor for exception com.github.ygimenez.exception.InvalidStateException: Default constructor.
isActivated() - Static method in class com.github.ygimenez.method.Pages: Checks whether this library has been activated or not.
isCancellable() - Method in class com.github.ygimenez.model.helper.BaseHelper: Returns whether the Emote.CANCEL button will be included or not.
isDeleteOnCancel() - Method in class com.github.ygimenez.model.Paginator: Retrieves whether the Message should be deleted or not when the button handler is removed.
If this is enabled, the bot will require Permission.MESSAGE_MANAGE permission for the deletion to work.
isEventLocked() - Method in class com.github.ygimenez.model.Paginator: Retrieves whether events will be locked to prevent double-activation of buttons before it finished previous processing (can help if experiencing race condition).
isEventLocking() - Method in class com.github.ygimenez.model.PaginatorBuilder: Retrieves whether events will be locked to prevent double-activation.
isFastForward() - Method in class com.github.ygimenez.model.helper.PaginateHelper: Retrives whether this helper is configured to include Emote.GOTO_FIRST and Emote.GOTO_LAST buttons.
isFromGuild() - Method in class com.github.ygimenez.model.PaginationEventWrapper: Retrieves whether the event happened in a guild or not.
isNative(MessageReaction) - Static method in enum com.github.ygimenez.type.Emote: Checks whether the supplied MessageReaction is referenced by a library emote or not.
isNative(Button) - Static method in enum com.github.ygimenez.type.Emote: Checks whether the supplied Button is referenced by a library emote or not.
isRemoveOnReact() - Method in class com.github.ygimenez.model.Paginator: Retrieves whether user reactions will be removed after pressing the button or not.
If this is enabled, the bot will require Permission.MESSAGE_MANAGE permission for the buttons to work.
isUsingButtons() - Method in class com.github.ygimenez.model.helper.BaseHelper: Returns whether the event is configured to use buttons or not.

L

lazyPaginate(Message, LazyPaginateHelper) - Static method in class com.github.ygimenez.method.Pages: Adds navigation buttons to the specified Message/MessageEmbed which will lazily load content by using supplied ThrowingFunction.
lazyPaginate(Message, ThrowingFunction<Integer, Page>, boolean) - Static method in class com.github.ygimenez.method.Pages: Adds navigation buttons to the specified Message/MessageEmbed which will lazily load content by using supplied ThrowingFunction.
lazyPaginate(Message, ThrowingFunction<Integer, Page>, boolean, int, TimeUnit) - Static method in class com.github.ygimenez.method.Pages: Adds navigation buttons to the specified Message/MessageEmbed which will lazily load content by using supplied ThrowingFunction.
lazyPaginate(Message, ThrowingFunction<Integer, Page>, boolean, int, TimeUnit, Predicate<User>) - Static method in class com.github.ygimenez.method.Pages: Adds navigation buttons to the specified Message/MessageEmbed which will lazily load content by using supplied ThrowingFunction.
lazyPaginate(Message, ThrowingFunction<Integer, Page>, boolean, Predicate<User>) - Static method in class com.github.ygimenez.method.Pages: Adds navigation buttons to the specified Message/MessageEmbed which will lazily load content by using supplied ThrowingFunction.
lazyPaginate(Message, List<Page>, ThrowingFunction<Integer, Page>, boolean) - Static method in class com.github.ygimenez.method.Pages: Adds navigation buttons to the specified Message/MessageEmbed which will lazily load content by using supplied ThrowingFunction.
lazyPaginate(Message, List<Page>, ThrowingFunction<Integer, Page>, boolean, int, TimeUnit) - Static method in class com.github.ygimenez.method.Pages: Adds navigation buttons to the specified Message/MessageEmbed which will lazily load content by using supplied ThrowingFunction.
lazyPaginate(Message, List<Page>, ThrowingFunction<Integer, Page>, boolean, int, TimeUnit, Predicate<User>) - Static method in class com.github.ygimenez.method.Pages: Adds navigation buttons to the specified Message/MessageEmbed which will lazily load content by using supplied ThrowingFunction.
lazyPaginate(Message, List<Page>, ThrowingFunction<Integer, Page>, boolean, Predicate<User>) - Static method in class com.github.ygimenez.method.Pages: Adds navigation buttons to the specified Message/MessageEmbed which will lazily load content by using supplied ThrowingFunction.
LazyPaginateHelper - Class in com.github.ygimenez.model.helper: Helper class for building lazy-paginate events, safe for reuse.
LazyPaginateHelper(ThrowingFunction<Integer, Page>, boolean) - Constructor for class com.github.ygimenez.model.helper.LazyPaginateHelper: Creates a new lazy-paginate event helper with the supplied page loader and default list implementation (ArrayList).
LazyPaginateHelper(ThrowingFunction<Integer, Page>, List<Page>, boolean) - Constructor for class com.github.ygimenez.model.helper.LazyPaginateHelper: Creates a new lazy-paginate event helper with the supplied page loader and a list of initially loaded pages.
LEVEL_1 - Enum constant in enum com.github.ygimenez.model.PUtilsConfig.LogLevel: Logs only important events such as errors and dangerous actions (equivalent to ERROR level).
LEVEL_2 - Enum constant in enum com.github.ygimenez.model.PUtilsConfig.LogLevel: All previous events plus minor issues (equivalent to WARN level).
LEVEL_3 - Enum constant in enum com.github.ygimenez.model.PUtilsConfig.LogLevel: All previous events plus hints and general information (equivalent to INFO level).
LEVEL_4 - Enum constant in enum com.github.ygimenez.model.PUtilsConfig.LogLevel: All previous events plus debugging messages (equivalent to DEBUG level).
load(int) - Method in class com.github.ygimenez.model.helper.LazyPaginateHelper: Loads the page represented by the specified index.
log(PUtilsConfig.LogLevel, String) - Method in class com.github.ygimenez.model.Paginator: Utility method to log an error at the supplied PUtilsConfig.LogLevel.
log(PUtilsConfig.LogLevel, String, Throwable) - Method in class com.github.ygimenez.model.Paginator: Utility method to log an error at the supplied PUtilsConfig.LogLevel.

M

makeButton(Emote) - Method in class com.github.ygimenez.model.InteractPage: Creates a new Button from configured styles and captions.
makeButton(Emoji) - Method in class com.github.ygimenez.model.InteractPage: Creates a new Button, but without any style or caption applied to it.
makeButton(Emoji, String) - Method in class com.github.ygimenez.model.InteractPage: Creates a new Button, but without any style applied to it.
MessageHandler - Class in com.github.ygimenez.listener: Class responsible for handling reaction events sent by the handler.
Only one event is added to the handler to prevent cluttering and unnecessary listeners.
MessageHandler() - Constructor for class com.github.ygimenez.listener.MessageHandler: Creates a new MessageHandler instance.
modifyButtons(Message, Page, Map<String, Function<Button, Button>>) - Static method in class com.github.ygimenez.method.Pages: Utility method for switching pages and/or modifying message buttons.

N

NEXT - Enum constant in enum com.github.ygimenez.type.Emote: Emote representing the "next" button (default: ▶).
NONE - Enum constant in enum com.github.ygimenez.model.PUtilsConfig.LogLevel: Disables all event logging.
NONE - Enum constant in enum com.github.ygimenez.type.Emote: Emote representing nothing.
NullPageException - Exception in com.github.ygimenez.exception: Exception thrown when trying to paginate an empty List or action returned a null Page.
NullPageException() - Constructor for exception com.github.ygimenez.exception.NullPageException: Default constructor.
NullPageException(Message) - Constructor for exception com.github.ygimenez.exception.NullPageException: Parametrized constructor.

O

onButtonInteraction(ButtonInteractionEvent) - Method in class com.github.ygimenez.listener.MessageHandler
onMessageDelete(MessageDeleteEvent) - Method in class com.github.ygimenez.listener.MessageHandler
onMessageReactionAdd(MessageReactionAddEvent) - Method in class com.github.ygimenez.listener.MessageHandler
onMessageReactionRemove(MessageReactionRemoveEvent) - Method in class com.github.ygimenez.listener.MessageHandler
overrideStyle(ButtonStyle, ButtonStyle) - Method in class com.github.ygimenez.model.InteractPage: Override a Button style (for example, making Emote.ACCEPT button become red).

P

Page - Class in com.github.ygimenez.model: Class representing either a String or MessageEmbed object.
Page(Object) - Constructor for class com.github.ygimenez.model.Page: A Page object to be used in this library's methods.
Pages - Class in com.github.ygimenez.method: The main class containing all pagination-related methods, including but not limited to Pages.paginate(net.dv8tion.jda.api.entities.Message, java.util.List<com.github.ygimenez.model.Page>, boolean), Pages.categorize(net.dv8tion.jda.api.entities.Message, java.util.Map<net.dv8tion.jda.api.entities.emoji.Emoji, com.github.ygimenez.model.Page>, boolean), Pages.buttonize(net.dv8tion.jda.api.entities.Message, java.util.Map<net.dv8tion.jda.api.entities.emoji.Emoji, com.github.ygimenez.model.ThrowingConsumer<com.github.ygimenez.model.ButtonWrapper>>, boolean, boolean) and Pages.lazyPaginate(net.dv8tion.jda.api.entities.Message, com.github.ygimenez.model.ThrowingFunction<java.lang.Integer, com.github.ygimenez.model.Page>, boolean).
paginate(Message, PaginateHelper) - Static method in class com.github.ygimenez.method.Pages: Adds navigation buttons to the specified Message/MessageEmbed which will navigate through a given List of pages.
paginate(Message, List<Page>, boolean) - Static method in class com.github.ygimenez.method.Pages: Adds navigation buttons to the specified Message/MessageEmbed which will navigate through a given List of pages.
paginate(Message, List<Page>, boolean, boolean) - Static method in class com.github.ygimenez.method.Pages: Adds navigation buttons to the specified Message/MessageEmbed which will navigate through a given List of pages.
paginate(Message, List<Page>, boolean, boolean, Predicate<User>) - Static method in class com.github.ygimenez.method.Pages: Adds navigation buttons to the specified Message/MessageEmbed which will navigate through a given List of pages.
paginate(Message, List<Page>, boolean, int) - Static method in class com.github.ygimenez.method.Pages: Adds navigation buttons to the specified Message/MessageEmbed which will navigate through a given List of pages.
paginate(Message, List<Page>, boolean, int, boolean, Predicate<User>) - Static method in class com.github.ygimenez.method.Pages: Adds navigation buttons to the specified Message/MessageEmbed which will navigate through a given List of pages.
paginate(Message, List<Page>, boolean, int, TimeUnit) - Static method in class com.github.ygimenez.method.Pages: Adds navigation buttons to the specified Message/MessageEmbed which will navigate through a given List of pages.
paginate(Message, List<Page>, boolean, int, TimeUnit, boolean) - Static method in class com.github.ygimenez.method.Pages: Adds navigation buttons to the specified Message/MessageEmbed which will navigate through a given List of pages.
paginate(Message, List<Page>, boolean, int, TimeUnit, boolean, Predicate<User>) - Static method in class com.github.ygimenez.method.Pages: Adds navigation buttons to the specified Message/MessageEmbed which will navigate through a given List of pages.
paginate(Message, List<Page>, boolean, int, TimeUnit, int) - Static method in class com.github.ygimenez.method.Pages: Adds navigation buttons to the specified Message/MessageEmbed which will navigate through a given List of pages.
paginate(Message, List<Page>, boolean, int, TimeUnit, int, boolean) - Static method in class com.github.ygimenez.method.Pages: Adds navigation buttons to the specified Message/MessageEmbed which will navigate through a given List of pages.
paginate(Message, List<Page>, boolean, int, TimeUnit, int, boolean, Predicate<User>) - Static method in class com.github.ygimenez.method.Pages: Adds navigation buttons to the specified Message/MessageEmbed which will navigate through a given List of pages.
paginate(Message, List<Page>, boolean, int, TimeUnit, int, Predicate<User>) - Static method in class com.github.ygimenez.method.Pages: Adds navigation buttons to the specified Message/MessageEmbed which will navigate through a given List of pages.
paginate(Message, List<Page>, boolean, int, TimeUnit, Predicate<User>) - Static method in class com.github.ygimenez.method.Pages: Adds navigation buttons to the specified Message/MessageEmbed which will navigate through a given List of pages.
paginate(Message, List<Page>, boolean, int, Predicate<User>) - Static method in class com.github.ygimenez.method.Pages: Adds navigation buttons to the specified Message/MessageEmbed which will navigate through a given List of pages.
paginate(Message, List<Page>, boolean, Predicate<User>) - Static method in class com.github.ygimenez.method.Pages: Adds navigation buttons to the specified Message/MessageEmbed which will navigate through a given List of pages.
PaginateHelper - Class in com.github.ygimenez.model.helper: Helper class for building paginate events, safe for reuse.
PaginateHelper(boolean) - Constructor for class com.github.ygimenez.model.helper.PaginateHelper: Creates a new paginate event helper with the default list implementation (ArrayList).
PaginateHelper(List<Page>, boolean) - Constructor for class com.github.ygimenez.model.helper.PaginateHelper: Creates a new paginate event helper with the supplied list.
PaginationEventWrapper - Class in com.github.ygimenez.model: Wrapper for library events containing necessary data for handling.
PaginationEventWrapper(Object, User, MessageChannel, String, Object, boolean) - Constructor for class com.github.ygimenez.model.PaginationEventWrapper: Constructs a new PaginationEventWrapper instance.
Paginator - Class in com.github.ygimenez.model: This is the core object for Pagination-Utils' settings.

All settings changed during Paginator creation will reflect across the whole library, allowing further customization of it.

This class must only be instantiated by PaginatorBuilder.
Paginator() - Constructor for class com.github.ygimenez.model.Paginator: You shouldn't create a Paginator instance directly, please use PaginatorBuilder.
Paginator(Object) - Constructor for class com.github.ygimenez.model.Paginator: You shouldn't create a Paginator instance directly, please use PaginatorBuilder.
PaginatorBuilder - Class in com.github.ygimenez.model: Paginator's builder, this class allows you to customize Pagination-Utils' behavior as you like.
If you want a quick setup, use PaginatorBuilder.createSimplePaginator(JDA) or PaginatorBuilder.createSimplePaginator(ShardManager).
PREVIOUS - Enum constant in enum com.github.ygimenez.type.Emote: Emote representing the "previous" button (default: ◀).
PUtilsConfig - Class in com.github.ygimenez.model: Utility class holding library-wide settings.
PUtilsConfig.LogLevel - Enum in com.github.ygimenez.model: Levels used to filter what events are logged to the console by the library.

R

reloadMessage() - Method in class com.github.ygimenez.model.ButtonWrapper: Reloads current parent Message instance, retrieving the latest state of it (useful when doing Button updates or actions which depend on message content).
reloadMessage(Message) - Static method in class com.github.ygimenez.method.Pages: Utility method for re-fetching a message.
removeEvent(Message) - Method in class com.github.ygimenez.listener.MessageHandler: Removes an event from the handler.
retrieveMessage() - Method in class com.github.ygimenez.model.PaginationEventWrapper: Fetch the Message from the event's Message ID.

S

setCancellable(boolean) - Method in class com.github.ygimenez.model.helper.BaseHelper: Set whether the event is cancellable through Emote.CANCEL.
setCanInteract(Predicate<User>) - Method in class com.github.ygimenez.model.helper.BaseHelper: Set the condition used to check if a given user can interact with the event buttons.
setDeleteOnCancel(boolean) - Method in class com.github.ygimenez.model.Paginator: Set whether Message should be deleted or not when the button handler is removed.
setDeleteOnCancel(boolean) - Method in class com.github.ygimenez.model.PaginatorBuilder: Set whether Message should be deleted or not when the button handler is removed.
setEmote(Emote, String) - Method in class com.github.ygimenez.model.PaginatorBuilder: Modify an Emote's code from the Map.
setEmote(Emote, Emoji) - Method in class com.github.ygimenez.model.PaginatorBuilder: Modify an Emote from the Map.
setEventLocked(boolean) - Method in class com.github.ygimenez.model.Paginator: Set whether evens should be locked to prevent double-activation.
setFastForward(boolean) - Method in class com.github.ygimenez.model.helper.PaginateHelper: Set whether to include Emote.GOTO_FIRST and Emote.GOTO_LAST buttons for quick navigation through the pages.
setHandler(Object) - Method in class com.github.ygimenez.model.Paginator: Set the handler used for event processing.
setHandler(JDA) - Method in class com.github.ygimenez.model.PaginatorBuilder: Set the handler used for event processing.
setHandler(ShardManager) - Method in class com.github.ygimenez.model.PaginatorBuilder: Set the handler used for event processing.
setLogLevel(PUtilsConfig.LogLevel) - Static method in class com.github.ygimenez.model.PUtilsConfig: Set the library's PUtilsConfig.LogLevel.
setOnFinalization(Consumer<Message>) - Method in class com.github.ygimenez.model.helper.ButtonizeHelper: Defines an action to be executed when the event finishes, either by user action or timed finalization.
setOnRemove(ThrowingConsumer<InteractionHook>) - Static method in class com.github.ygimenez.model.PUtilsConfig: Set the action to be performed when encountering an unmapped event.
setRemoveOnReact(boolean) - Method in class com.github.ygimenez.model.Paginator: Set whether user reactions will be removed after pressing the button or not.
setSkipAmount(int) - Method in class com.github.ygimenez.model.helper.PaginateHelper: Set the amount of pages to be skipped on pressing Emote.SKIP_BACKWARD or Emote.SKIP_FORWARD.
setTimeout(int, TimeUnit) - Method in class com.github.ygimenez.model.helper.BaseHelper: Set the timeout for automatically cancelling the event.
shouldDeleteOnCancel() - Method in class com.github.ygimenez.model.PaginatorBuilder: Retrieves whether the Message should be deleted or not when the button handler is removed.
If this is enabled, the bot will require Permission.MESSAGE_MANAGE permission for the deletion to work.
shouldEventLock(boolean) - Method in class com.github.ygimenez.model.PaginatorBuilder: Set whether evens should be locked to prevent double-activation of buttons before it finished previous processing (can help if experiencing race condition).
shouldRemoveOnReact(boolean) - Method in class com.github.ygimenez.model.PaginatorBuilder: Set whether user reactions will be removed after pressing the button or not.
shouldUpdate(Message) - Method in class com.github.ygimenez.model.helper.BaseHelper: Calculates whether the Message needs to have buttons applied onto or not.
shouldUpdate(Message) - Method in class com.github.ygimenez.model.helper.ButtonizeHelper: Calculates whether the Message needs to have buttons applied onto or not.
shouldUpdate(Message) - Method in class com.github.ygimenez.model.helper.CategorizeHelper: Calculates whether the Message needs to have buttons applied onto or not.
shouldUpdate(Message) - Method in class com.github.ygimenez.model.helper.LazyPaginateHelper: Calculates whether the Message needs to have buttons applied onto or not.
shouldUpdate(Message) - Method in class com.github.ygimenez.model.helper.PaginateHelper: Calculates whether the Message needs to have buttons applied onto or not.
SKIP_BACKWARD - Enum constant in enum com.github.ygimenez.type.Emote: Emote representing the "skip backward" button (default: ⏪).
SKIP_FORWARD - Enum constant in enum com.github.ygimenez.type.Emote: Emote representing the "skip forward" button (default: ⏩).
subGet(RestAction<T>) - Static method in class com.github.ygimenez.method.Pages: Utility method for submitting a RestAction and awaiting its result.
subGet(RestAction<T>, T) - Static method in class com.github.ygimenez.method.Pages: Utility method for submitting a RestAction and awaiting its result.

T

ThrowingBiConsumer<A,B> - Interface in com.github.ygimenez.model: Represents an operation that accepts two input arguments and returns no result.
ThrowingConsumer<A> - Interface in com.github.ygimenez.model: Represents an operation that accepts one input argument and returns no result.
ThrowingFunction<T,R> - Interface in com.github.ygimenez.model: Represents a function that accepts one argument and produces a result.
ThrowingTriConsumer<A,B,C> - Interface in com.github.ygimenez.model: Represents an operation that accepts three input arguments and returns no result.
toString() - Method in class com.github.ygimenez.model.Page: Method to get this Page's main String content (Message content or MessageEmbed description).

V

valueOf(String) - Static method in enum com.github.ygimenez.model.PUtilsConfig.LogLevel: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.github.ygimenez.type.Emote: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.github.ygimenez.model.PUtilsConfig.LogLevel: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.github.ygimenez.type.Emote: Returns an array containing the constants of this enum type, in the order they are declared.

W

willRemoveOnReact() - Method in class com.github.ygimenez.model.PaginatorBuilder: Retrieves whether user reactions will be removed after pressing the button or not.
If this is enabled, the bot will require Permission.MESSAGE_MANAGE permission for the buttons to work.

A B C D E F G I L M N O P R S T V W
All Classes|All Packages|Serialized Form