Package net.dv8tion.jda.api.utils

package net.dv8tion.jda.api.utils

Package which contains all utilities for the JDA library. These are used by JDA itself and can also be useful for the library user!

List of utilities:

• MiscUtil
  Various operations that don't have specific utility classes yet, mostly internals that are accessible from JDA entities
• WidgetUtil
  This is not bound to a JDA instance and can view the Widget for a specified Guild. (by id)
• MarkdownSanitizer
  Parser for Discord markdown that can either escape or strip markdown from a string
• SessionController
  Special handler for session (re-)connects and global rate-limits
• TimeUtil
  Useful time conversion methods related to Discord

Related Packages

Package	Description
net.dv8tion.jda.api	The API features of JDA.
net.dv8tion.jda.api.utils.cache	Interfaces for read-only access to internal JDA cache.
net.dv8tion.jda.api.utils.concurrent	Implementations for threading related functionality such as Thread-Factories.
net.dv8tion.jda.api.utils.data	Serialization features used for communication with Discord.
net.dv8tion.jda.api.utils.messages	Utilities for message building and formatting.

Class	Description
AttachedFile	Represents files that are attached to requests.
AttachmentProxy	A utility class to retrieve attachments.
AttachmentUpdate	Represents existing message attachment.
ChunkingFilter	Filter function for member chunking of guilds.
ClosableIterator<T>	Iterator holding a resource that must be free'd by the consumer.
Compression	Compression algorithms that can be used with JDA.
ConcurrentSessionController	Implementation of SessionController which respects concurrent shard login.
FileProxy	A utility class to download files.
FileUpload	Represents a file that is intended to be uploaded to Discord for arbitrary requests.
ImageProxy	A utility class to retrieve images.
IOBiConsumer<T,R>	Consumer accepting two arguments and throwing IOException.
IOConsumer<T>	Consumer accepting one argument and throwing IOException.
IOFunction<T,R>	Function accepting one argument and throwing IOException.
LockIterator<T>	Simple implementation of a ClosableIterator that uses a lock.
MarkdownSanitizer	Implements an algorithm that can strip or replace markdown in any supplied string.
MarkdownSanitizer.SanitizationStrategy
MarkdownUtil	Utility class to escape markdown characters.
MemberCachePolicy	Policy which decides whether a member (and respective user) should be kept in cache.
MiscUtil	Utility methods for various aspects of the API.
Once<E extends GenericEvent>	Helper class to listen to an event, once.
Once.Builder<E extends GenericEvent>	Builds a one-time event listener, can be reused.
Procedure<T>	Iteration procedure accepting one argument and returning whether to continue iteration.
Result<T>	Represents a computation or task result.
SessionController	Controls states and behaviour of one or multiple JDA instances.
SessionController.SessionConnectNode	Represents a WebSocketClient request to start a session.
SessionController.ShardedGateway	POJO containing the gateway endpoint and recommended shard total for a shard manager.
SessionControllerAdapter	Simple implementation of SessionController without supporting concurrency.
SplitUtil	Utility to strategically split strings.
SplitUtil.Strategy	Function which applies a programmable strategy used to determine a splitting point.
TimeFormat	Utility enum used to provide different markdown styles for timestamps.
Timestamp	Utility class representing Discord Markdown timestamps.
TimeUtil	Utility for various time related features of the API.
WidgetUtil	The WidgetUtil is a class for interacting with various facets of Discord's guild widgets
WidgetUtil.BannerType	Represents the available banner types Each of these has a different appearance:
WidgetUtil.WidgetTheme	Represents the color scheme of the widget These color themes match Discord's dark and light themes