Package net.dv8tion.jda.internal.requests.restaction.pagination

Class PaginationActionImpl<T,M extends PaginationAction<T,M>>

java.lang.Object

net.dv8tion.jda.internal.requests.RestActionImpl<List<T>>

net.dv8tion.jda.internal.requests.restaction.pagination.PaginationActionImpl<T,M>

All Implemented Interfaces:

Iterable<T>, RestAction<@Unmodifiable List<T>>, PaginationAction<T,M>

Direct Known Subclasses:

AuditLogPaginationActionImpl, BanPaginationActionImpl, EntitlementPaginationActionImpl, MessagePaginationActionImpl, PollVotersPaginationActionImpl, ReactionPaginationActionImpl, ScheduledEventMembersPaginationActionImpl, ThreadChannelPaginationActionImpl, ThreadMemberPaginationActionImpl

public abstract class PaginationActionImpl<T,M extends PaginationAction<T,M>>
extends RestActionImpl<List<T>>
implements PaginationAction<T,M>

Nested Class Summary

Nested classes/interfaces inherited from interface net.dv8tion.jda.api.requests.restaction.pagination.PaginationAction

PaginationAction.PaginationIterator<E>, PaginationAction.PaginationOrder

Field Summary

Fields inherited from class net.dv8tion.jda.internal.requests.RestActionImpl

LOG

Constructor Summary

Constructors

Constructor	Description
PaginationActionImpl(JDA api)	Creates a new PaginationAction instance This is used for PaginationActions that should not deal with limit(int)
PaginationActionImpl(JDA api, Route.CompiledRoute route, int minLimit, int maxLimit, int initialLimit)	Creates a new PaginationAction instance

Method Summary

Modifier and Type	Method	Description
M	cache(boolean enableCache)	Whether already retrieved entities should be stored within the internal cache.
int	cacheSize()	The current amount of cached entities for this PaginationAction
M	deadline(long timestamp)	Similar to RestAction.timeout(long, TimeUnit) but schedules a deadline at which the request has to be completed.
CompletableFuture<?>	forEachAsync(Procedure<? super T> action, Consumer<? super Throwable> failure)	Iterates over all entities until the provided action returns false! This operation is different from Iterable.forEach(Consumer) as it uses successive RestAction.queue() tasks to iterate each entity in callback threads instead of the calling active thread.
void	forEachRemaining(Procedure<? super T> action)	Iterates over all remaining entities until the provided action returns false! Skipping past already cached entities to iterate all remaining entities of this PaginationAction.
CompletableFuture<?>	forEachRemainingAsync(Procedure<? super T> action, Consumer<? super Throwable> failure)	Iterates over all remaining entities until the provided action returns false! This operation is different from PaginationAction.forEachRemaining(Procedure) as it uses successive RestAction.queue() tasks to iterate each entity in callback threads instead of the calling active thread.
List<T>	getCached()	The currently cached entities of recent execution tasks.
T	getFirst()	The first cached entity retrieved by this PaginationAction instance
T	getLast()	The most recent entity retrieved by this PaginationAction instance
long	getLastKey()	The current iteration anchor used for pagination.
final int	getLimit()	The currently used limit.
final int	getMaxLimit()	The maximum limit that can be used for this PaginationAction Limits provided to PaginationAction.limit(int) must not be greater than the returned value.
final int	getMinLimit()	The minimum limit that can be used for this PaginationAction Limits provided to PaginationAction.limit(int) must not be less than the returned value.
List<T>	getNextChunk()
PaginationAction.PaginationOrder	getOrder()	The current iteration order.
boolean	isCacheEnabled()	Whether retrieved entities are stored within an internal cache.
boolean	isEmpty()	Whether the cache of this PaginationAction is empty.
PaginationAction.PaginationIterator<T>	iterator()	PaginationIterator that will iterate over all entities for this PaginationAction.
M	limit(int limit)	Sets the limit that should be used in the next RestAction completion call.
M	order(PaginationAction.PaginationOrder order)	Configure the PaginationAction.PaginationOrder of this pagination action.
M	setCheck(BooleanSupplier checks)	Sets the last-second checks before finally executing the http request in the queue.
M	skipTo(long id)	Skips past the specified ID for successive requests.
CompletableFuture<List<T>>	takeAsync(int amount)	Convenience method to retrieve an amount of entities from this pagination action.
CompletableFuture<List<T>>	takeRemainingAsync(int amount)	Convenience method to retrieve an amount of entities from this pagination action.
M	timeout(long timeout, TimeUnit unit)	Timeout for this RestAction instance.

Methods inherited from class net.dv8tion.jda.internal.requests.RestActionImpl

complete, getCheck, getDefaultFailure, getDefaultSuccess, getDefaultTimeout, getJDA, handleResponse, isPassContext, priority, queue, setDefaultFailure, setDefaultSuccess, setDefaultTimeout, setErrorMapper, setPassContext, submit

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from interface net.dv8tion.jda.api.requests.restaction.pagination.PaginationAction

forEachAsync, forEachRemainingAsync, getSupportedOrders, parallelStream, reverse, spliterator, stream, takeUntilAsync, takeUntilAsync, takeWhileAsync, takeWhileAsync

Methods inherited from interface net.dv8tion.jda.api.requests.RestAction

addCheck, and, and, complete, complete, completeAfter, delay, delay, delay, delay, flatMap, flatMap, getCheck, getJDA, map, mapToResult, onErrorFlatMap, onErrorFlatMap, onErrorMap, onErrorMap, onSuccess, queue, queue, queue, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, submit, submit, submitAfter, submitAfter, zip

Constructor Details

PaginationActionImpl

public PaginationActionImpl(JDA api,
 Route.CompiledRoute route,
 int minLimit,
 int maxLimit,
 int initialLimit)

Creates a new PaginationAction instance

Parameters:

api - The current JDA instance

route - The base route

minLimit - The inclusive minimum limit that can be used in limit(int)

maxLimit - The inclusive maximum limit that can be used in limit(int)

initialLimit - The initial limit to use on the pagination endpoint

PaginationActionImpl

public PaginationActionImpl(JDA api)

Creates a new PaginationAction instance
This is used for PaginationActions that should not deal with limit(int)

Parameters:

api - The current JDA instance

Method Details

skipTo

@Nonnull
public M skipTo(long id)

Description copied from interface: PaginationAction

Skips past the specified ID for successive requests. This will reset the PaginationAction.getLast() entity and cause a NoSuchElementException to be thrown when attempting to get the last entity until a new retrieve action has been done.
If cache is disabled this can be set to an arbitrary value irrelevant of the current last. Set this to 0 to start from the most recent message.

Fails if cache is enabled and the target id is newer than the current last id (id > last).

Example

 public MessagePaginationAction getOlderThan(MessageChannel channel, long time) {
     final long timestamp = TimeUtil.getDiscordTimestamp(time);
     final MessagePaginationAction paginator = channel.getIterableHistory();
     return paginator.skipTo(timestamp);
 }

 getOlderThan(channel, System.currentTimeMillis() - TimeUnit.DAYS.toMillis(14))
     .forEachAsync((message) -> {
         boolean empty = message.getContentRaw().isEmpty();
         if (!empty)
             System.out.printf("%#s%n", message); // means: print display content
         return !empty; // means: continue if not empty
     });
 

Specified by:

skipTo in interface PaginationAction<T,M extends PaginationAction<T,M>>

Parameters:

id - The snowflake ID to skip before, this is exclusive rather than inclusive

Returns:

The current PaginationAction for chaining convenience

See Also:

• TimeUnit
• TimeUtil

getLastKey

public long getLastKey()

Description copied from interface: PaginationAction

The current iteration anchor used for pagination.
This is updated by each retrieve action.

Specified by:

getLastKey in interface PaginationAction<T,M extends PaginationAction<T,M>>

Returns:

The current iteration anchor

See Also:

• Use skipTo(anchor) to change this

getOrder

@Nonnull
public PaginationAction.PaginationOrder getOrder()

Description copied from interface: PaginationAction

The current iteration order.
This defaults to PaginationAction.PaginationOrder.BACKWARD, meaning most recent first, for most pagination endpoints.

Specified by:

getOrder in interface PaginationAction<T,M extends PaginationAction<T,M>>

Returns:

The PaginationAction.PaginationOrder

See Also:

• PaginationAction.order(PaginationOrder)

order

@Nonnull
public M order(@Nonnull
 PaginationAction.PaginationOrder order)

Description copied from interface: PaginationAction

Configure the PaginationAction.PaginationOrder of this pagination action.

You can only supply supported orders, see PaginationAction.getSupportedOrders().

Specified by:

order in interface PaginationAction<T,M extends PaginationAction<T,M>>

Parameters:

order - The pagination order

Returns:

The current PaginationAction implementation instance

See Also:

• PaginationAction.getSupportedOrders()
• PaginationAction.reverse()

setCheck

@Nonnull
public M setCheck(BooleanSupplier checks)

Description copied from interface: RestAction

Sets the last-second checks before finally executing the http request in the queue.
If the provided supplier evaluates to false or throws an exception this will not be finished. When an exception is thrown from the supplier it will be provided to the failure callback.

Specified by:

setCheck in interface PaginationAction<T,M extends PaginationAction<T,M>>

Specified by:

setCheck in interface RestAction<T>

Overrides:

setCheck in class RestActionImpl<List<T>>

Parameters:

checks - The checks to run before executing the request, or null to run no checks

Returns:

The current RestAction for chaining convenience

See Also:

• RestAction.getCheck()
• RestAction.addCheck(BooleanSupplier)

timeout

@Nonnull
public M timeout(long timeout,
 @Nonnull
 TimeUnit unit)

Description copied from interface: RestAction

Timeout for this RestAction instance.
If the request doesn't get executed within the timeout it will fail.

When a RestAction times out, it will fail with a TimeoutException. This is the same as deadline(System.currentTimeMillis() + unit.toMillis(timeout)).

Example

 action.timeout(10, TimeUnit.SECONDS) // 10 seconds from now
       .queueAfter(20, SECONDS); // request will not be executed within deadline and timeout immediately after 20 seconds
 

Specified by:

timeout in interface PaginationAction<T,M extends PaginationAction<T,M>>

Specified by:

timeout in interface RestAction<T>

Parameters:

timeout - The timeout to use

unit - Unit for the timeout value

Returns:

The same RestAction instance with the applied timeout

See Also:

• RestAction.setDefaultTimeout(long, TimeUnit)

deadline

@Nonnull
public M deadline(long timestamp)

Description copied from interface: RestAction

Similar to RestAction.timeout(long, TimeUnit) but schedules a deadline at which the request has to be completed.
If the deadline is reached, the request will fail with a TimeoutException.

This does not mean that the request will immediately timeout when the deadline is reached. JDA will check the deadline right before executing the request or within intervals in a worker thread. This only means the request will timeout if the deadline has passed.

Example

 action.deadline(System.currentTimeMillis() + 10000) // 10 seconds from now
       .queueAfter(20, SECONDS); // request will not be executed within deadline and timeout immediately after 20 seconds
 

Specified by:

deadline in interface PaginationAction<T,M extends PaginationAction<T,M>>

Specified by:

deadline in interface RestAction<T>

Overrides:

deadline in class RestActionImpl<List<T>>

Parameters:

timestamp - Millisecond timestamp at which the request will timeout

Returns:

The same RestAction with the applied deadline

See Also:

• RestAction.timeout(long, TimeUnit)
• RestAction.setDefaultTimeout(long, TimeUnit)

cacheSize

public int cacheSize()

Description copied from interface: PaginationAction

The current amount of cached entities for this PaginationAction

Specified by:

cacheSize in interface PaginationAction<T,M extends PaginationAction<T,M>>

Returns:

int size of currently cached entities

isEmpty

public boolean isEmpty()

Description copied from interface: PaginationAction

Whether the cache of this PaginationAction is empty.
Logically equivalent to cacheSize() == 0.

Specified by:

isEmpty in interface PaginationAction<T,M extends PaginationAction<T,M>>

Returns:

True, if no entities have been retrieved yet.

getCached

@Nonnull
public List<T> getCached()

Description copied from interface: PaginationAction

The currently cached entities of recent execution tasks.
Every RestAction success adds to this List. (Thread-Safe due to CopyOnWriteArrayList)

This does not contain all entities for the paginated endpoint unless the pagination has reached an end!
It only contains those entities which already have been retrieved.

Specified by:

getCached in interface PaginationAction<T,M extends PaginationAction<T,M>>

Returns:

Immutable List containing all currently cached entities for this PaginationAction

getLast

@Nonnull
public T getLast()

Description copied from interface: PaginationAction

The most recent entity retrieved by this PaginationAction instance

Specified by:

getLast in interface PaginationAction<T,M extends PaginationAction<T,M>>

Returns:

The most recent cached entity

getFirst

@Nonnull
public T getFirst()

Description copied from interface: PaginationAction

The first cached entity retrieved by this PaginationAction instance

Specified by:

getFirst in interface PaginationAction<T,M extends PaginationAction<T,M>>

Returns:

The very first cached entity

limit

@Nonnull
public M limit(int limit)

Description copied from interface: PaginationAction

Sets the limit that should be used in the next RestAction completion call.

The specified limit may not be below the Minimum Limit nor above the Maximum Limit. Unless these limits are specifically omitted. (See documentation of methods)

This limit represents how many entities will be retrieved per request and NOT the maximum amount of entities that should be retrieved for iteration/sequencing.
action.limit(50).complete()
is not the same as
action.stream().limit(50).collect(collector)

Specified by:

limit in interface PaginationAction<T,M extends PaginationAction<T,M>>

Parameters:

limit - The limit to use

Returns:

The current PaginationAction implementation instance

cache

@Nonnull
public M cache(boolean enableCache)

Description copied from interface: PaginationAction

Whether already retrieved entities should be stored within the internal cache. All cached entities will be available from PaginationAction.getCached(). Default: true
This being disabled allows unused entities to be removed from the memory heap by the garbage collector. If this is enabled this will not take place until all references to this PaginationAction have been cleared.

Specified by:

cache in interface PaginationAction<T,M extends PaginationAction<T,M>>

Parameters:

enableCache - Whether to enable entity cache

Returns:

The current PaginationAction implementation instance

isCacheEnabled

public boolean isCacheEnabled()

Description copied from interface: PaginationAction

Whether retrieved entities are stored within an internal cache. If this is false entities retrieved by the iterator or a call to a RestAction terminal operation will not be retrievable from PaginationAction.getCached().
This being disabled allows unused entities to be removed from the memory heap by the garbage collector. If this is enabled this will not take place until all references to this PaginationAction have been cleared.

Specified by:

isCacheEnabled in interface PaginationAction<T,M extends PaginationAction<T,M>>

Returns:

True, If entities will be cached.

getMaxLimit

public final int getMaxLimit()

Description copied from interface: PaginationAction

The maximum limit that can be used for this PaginationAction
Limits provided to PaginationAction.limit(int) must not be greater than the returned value.
If no maximum limit is used this will return 0. That means there is no upper border for limiting this PaginationAction

Specified by:

getMaxLimit in interface PaginationAction<T,M extends PaginationAction<T,M>>

Returns:

The maximum limit

getMinLimit

public final int getMinLimit()

Description copied from interface: PaginationAction

The minimum limit that can be used for this PaginationAction
Limits provided to PaginationAction.limit(int) must not be less than the returned value.
If no minimum limit is used this will return 0. That means there is no lower border for limiting this PaginationAction

Specified by:

getMinLimit in interface PaginationAction<T,M extends PaginationAction<T,M>>

Returns:

The minimum limit

getLimit

public final int getLimit()

Description copied from interface: PaginationAction

The currently used limit.
If this PaginationAction does not use limitation this will return 0

Specified by:

getLimit in interface PaginationAction<T,M extends PaginationAction<T,M>>

Returns:

limit

takeAsync

@Nonnull
public CompletableFuture<List<T>> takeAsync(int amount)

Description copied from interface: PaginationAction

Convenience method to retrieve an amount of entities from this pagination action.
This also includes already cached entities similar to PaginationAction.forEachAsync(Procedure).

Specified by:

takeAsync in interface PaginationAction<T,M extends PaginationAction<T,M>>

Parameters:

amount - The maximum amount to retrieve

Returns:

CompletableFuture - Type: List

See Also:

• PaginationAction.forEachAsync(Procedure)

takeRemainingAsync

@Nonnull
public CompletableFuture<List<T>> takeRemainingAsync(int amount)

Description copied from interface: PaginationAction

Convenience method to retrieve an amount of entities from this pagination action.
Unlike PaginationAction.takeAsync(int) this does not include already cached entities.

Specified by:

takeRemainingAsync in interface PaginationAction<T,M extends PaginationAction<T,M>>

Parameters:

amount - The maximum amount to retrieve

Returns:

CompletableFuture - Type: List

See Also:

• PaginationAction.forEachRemainingAsync(Procedure)

iterator

@Nonnull
public PaginationAction.PaginationIterator<T> iterator()

Description copied from interface: PaginationAction

PaginationIterator that will iterate over all entities for this PaginationAction.

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface PaginationAction<T,M extends PaginationAction<T,M>>

Returns:

new PaginationIterator

forEachAsync

@Nonnull
public CompletableFuture<?> forEachAsync(@Nonnull
 Procedure<? super T> action,
 @Nonnull
 Consumer<? super Throwable> failure)

Description copied from interface: PaginationAction

Iterates over all entities until the provided action returns false!
This operation is different from Iterable.forEach(Consumer) as it uses successive RestAction.queue() tasks to iterate each entity in callback threads instead of the calling active thread. This means that this method fully works on different threads to retrieve new entities.

This iteration will include already cached entities, in order to exclude cached entities use PaginationAction.forEachRemainingAsync(Procedure, Consumer)

Example

 //deletes messages until it finds a user that is still in guild
 public void cleanupMessages(MessagePaginationAction action)
 {
     action.forEachAsync( (message) ->
     {
         Guild guild = message.getGuild();
         if (!guild.isMember(message.getAuthor()))
             message.delete().queue();
         else
             return false;
         return true;
     }, Throwable::printStackTrace);
 }
 

Specified by:

forEachAsync in interface PaginationAction<T,M extends PaginationAction<T,M>>

Parameters:

action - Procedure returning true if iteration should continue!

failure - Consumer that should handle any throwables from the action

Returns:

Future that can be cancelled to stop iteration from outside!

forEachRemainingAsync

@Nonnull
public CompletableFuture<?> forEachRemainingAsync(@Nonnull
 Procedure<? super T> action,
 @Nonnull
 Consumer<? super Throwable> failure)

Description copied from interface: PaginationAction

Iterates over all remaining entities until the provided action returns false!
This operation is different from PaginationAction.forEachRemaining(Procedure) as it uses successive RestAction.queue() tasks to iterate each entity in callback threads instead of the calling active thread. This means that this method fully works on different threads to retrieve new entities.

This iteration will exclude already cached entities, in order to include cached entities use PaginationAction.forEachAsync(Procedure, Consumer)

Example

 //deletes messages until it finds a user that is still in guild
 public void cleanupMessages(MessagePaginationAction action)
 {
     action.forEachRemainingAsync( (message) ->
     {
         Guild guild = message.getGuild();
         if (!guild.isMember(message.getAuthor()))
             message.delete().queue();
         else
             return false;
         return true;
     }, Throwable::printStackTrace);
 }
 

Specified by:

forEachRemainingAsync in interface PaginationAction<T,M extends PaginationAction<T,M>>

Parameters:

action - Procedure returning true if iteration should continue!

failure - Consumer that should handle any throwables from the action

Returns:

Future that can be cancelled to stop iteration from outside!

forEachRemaining

public void forEachRemaining(@Nonnull
 Procedure<? super T> action)

Description copied from interface: PaginationAction

Iterates over all remaining entities until the provided action returns false!
Skipping past already cached entities to iterate all remaining entities of this PaginationAction.

This is a blocking operation that might take a while to complete

Specified by:

forEachRemaining in interface PaginationAction<T,M extends PaginationAction<T,M>>

Parameters:

action - The Procedure which should return true to continue iterating

getNextChunk

public List<T> getNextChunk()