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

Class RestActionOperator<I,O>

java.lang.Object

net.dv8tion.jda.internal.requests.restaction.operator.RestActionOperator<I,O>

All Implemented Interfaces:

RestAction<O>

Direct Known Subclasses:

DelayRestAction, FlatMapErrorRestAction, FlatMapRestAction, MapErrorRestAction, MapRestAction

public abstract class RestActionOperator<I,O>
extends Object
implements RestAction<O>

Constructor Summary

Constructors

Constructor	Description
RestActionOperator(RestAction<I> action)

Method Summary

Modifier and Type	Method	Description
RestAction<O>	deadline(long timestamp)	Similar to RestAction.timeout(long, TimeUnit) but schedules a deadline at which the request has to be completed.
BooleanSupplier	getCheck()	The current checks for this RestAction.
JDA	getJDA()	The current JDA instance
RestAction<O>	setCheck(BooleanSupplier checks)	Sets the last-second checks before finally executing the http request in the queue.

Methods inherited from class java.lang.Object

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

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

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

Constructor Details

RestActionOperator

public RestActionOperator(RestAction<I> action)

Method Details

getJDA

@Nonnull
public JDA getJDA()

Description copied from interface: RestAction

The current JDA instance

Specified by:

getJDA in interface RestAction<I>

Returns:

The corresponding JDA instance

setCheck

@Nonnull
public RestAction<O> setCheck(@Nullable
 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 RestAction<I>

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)

getCheck

@Nullable
public BooleanSupplier getCheck()

Description copied from interface: RestAction

The current checks for this RestAction.

Specified by:

getCheck in interface RestAction<I>

Returns:

The current checks, or null if none were set

See Also:

• RestAction.setCheck(BooleanSupplier)

deadline

@Nonnull
public RestAction<O> 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 RestAction<I>

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)