Package net.dv8tion.jda.api.requests.restaction.order

Interface OrderAction<T,M extends OrderAction<T,M>>

Type Parameters:

T - The entity type for the List of entities contained in the OrderAction's orderList

M - The extension implementing the abstract operations of this OrderAction, this will be important for chaining convenience as it returns the specific implementation rather than a mask of this class. It allows us to implement chaining operations in this class instead of having to implement it in every inheriting class!

All Superinterfaces:

RestAction<Void>

All Known Subinterfaces:

CategoryOrderAction, ChannelOrderAction, RoleOrderAction

public interface OrderAction<T,M extends OrderAction<T,M>>
extends RestAction<Void>

Extension of RestAction - Type: Void that allows to modify the order of entities provided as an ArrayList.
This action contains a List or entities for the specified type T which can be moved within the bounds but not removed, nor can any new entities be added.

Since:

3.0

Method Summary

Modifier and Type	Method	Description
M	deadline(long timestamp)	Similar to RestAction.timeout(long, TimeUnit) but schedules a deadline at which the request has to be completed.
@Unmodifiable List<T>	getCurrentOrder()	Immutable List representing the currently selected order of entities in this OrderAction instance
T	getSelectedEntity()	The entity which is currently at the selected position
int	getSelectedPosition()	The currently selected position that is in focus for all modification operations of this OrderAction instance
boolean	isAscendingOrder()	Whether this instance uses ascending order, from the lowest position to the highest.
M	moveAbove(T other)	Moves the currently selected entity above the specified target entity.
M	moveBelow(T other)	Moves the currently selected entity below the specified target entity.
M	moveDown(int amount)	Moves the currently selected entity amount positions DOWN in order by pushing all entities up by one position.
M	moveTo(int position)	Moves the currently selected entity to the specified position (0 based index).
M	moveUp(int amount)	Moves the currently selected entity amount positions UP in order by pushing all entities down by one position.
M	reverseOrder()	Reverses the current order by using Collections.reverse(orderList)
M	selectPosition(int selectedPosition)	Selects a new current entity at the specified index This index is in correlation to the current order
M	selectPosition(T selectedEntity)	Selects a new current entity based on the index of the specified entity in the current order This is a convenience function that uses selectPosition(int) internally
M	setCheck(BooleanSupplier checks)	Sets the last-second checks before finally executing the http request in the queue.
M	shuffleOrder()	Shuffles the current order by using Collections.shuffle(orderList)
M	sortOrder(Comparator<T> comparator)	Sorts the current order based on the specified Comparator by using ArrayList.sort(comparator)
M	swapPosition(int swapPosition)	Swaps the currently selected entity with the entity located at the specified position.
M	swapPosition(T swapEntity)	Swaps the currently selected entity with the specified entity.
M	timeout(long timeout, TimeUnit unit)	Timeout for this RestAction instance.

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

Method Details

setCheck

@Nonnull
@CheckReturnValue
M 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<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
@CheckReturnValue
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 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
@CheckReturnValue
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 RestAction<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)

isAscendingOrder

boolean isAscendingOrder()

Whether this instance uses ascending order, from the lowest position to the highest.

Returns:

True, if this uses ascending order

getCurrentOrder

@Nonnull
@Unmodifiable List<T> getCurrentOrder()

Immutable List representing the currently selected order of entities in this OrderAction instance

Returns:

Immutable List representing the current order

selectPosition

@Nonnull
@CheckReturnValue
M selectPosition(int selectedPosition)

Selects a new current entity at the specified index
This index is in correlation to the current order

Parameters:

selectedPosition - The index for the new position that will be in focus for all modification operations

Returns:

The current OrderAction sub-implementation instance

Throws:

IllegalArgumentException - If the provided position is out-of-bounds

See Also:

• getSelectedPosition()
• getSelectedEntity()

selectPosition

@Nonnull
@CheckReturnValue
M selectPosition(@Nonnull
 T selectedEntity)

Selects a new current entity based on the index of the specified entity in the current order
This is a convenience function that uses selectPosition(int) internally

Parameters:

selectedEntity - The entity for the new position that will be in focus for all modification operations

Returns:

The current OrderAction sub-implementation instance

See Also:

• selectPosition(int)
• getSelectedPosition()
• getSelectedEntity()

getSelectedPosition

int getSelectedPosition()

The currently selected position that is in focus for all modification operations of this OrderAction instance

Returns:

The currently selected index, or -1 if no position has been selected yet

getSelectedEntity

@Nonnull
T getSelectedEntity()

The entity which is currently at the selected position

Returns:

The currently selected entity

Throws:

IllegalStateException - If no entity has been selected yet, use selectPosition(Object)

moveUp

@Nonnull
@CheckReturnValue
M moveUp(int amount)

Moves the currently selected entity amount positions UP in order by pushing all entities down by one position.

Parameters:

amount - The amount of positions that should be moved

Returns:

The current OrderAction sub-implementation instance

Throws:

IllegalStateException - If no entity has been selected yet, use selectPosition(Object)

IllegalArgumentException - If the specified amount would cause the entity to go out-of-bounds

See Also:

• moveTo(int)

moveDown

@Nonnull
@CheckReturnValue
M moveDown(int amount)

Moves the currently selected entity amount positions DOWN in order by pushing all entities up by one position.

Parameters:

amount - The amount of positions that should be moved

Returns:

The current OrderAction sub-implementation instance

Throws:

IllegalStateException - If no entity has been selected yet, use selectPosition(Object)

IllegalArgumentException - If the specified amount would cause the entity to go out-of-bounds

See Also:

• moveTo(int)

moveTo

@Nonnull
@CheckReturnValue
M moveTo(int position)

Moves the currently selected entity to the specified position (0 based index). All entities are moved in the direction of the left hole to fill the gap.

Parameters:

position - The new not-negative position for the currently selected entity

Returns:

The current OrderAction sub-implementation instance

Throws:

IllegalStateException - If no entity has been selected yet, use selectPosition(Object)

IllegalArgumentException - If the specified position is out-of-bounds

See Also:

• moveDown(int)
• moveUp(int)
• moveBelow(Object)
• moveAbove(Object)

moveBelow

@Nonnull
@CheckReturnValue
M moveBelow(@Nonnull
 T other)

Moves the currently selected entity below the specified target entity.

Parameters:

other - The reference entity that should end up above the selected entity

Returns:

The current OrderAction sub-implementation instance

Throws:

IllegalStateException - If no entity has been selected yet, use selectPosition(Object)

IllegalArgumentException - If the specified target entity is not managed by this instance or null

See Also:

• moveUp(int)
• moveDown(int)
• moveAbove(Object)

moveAbove

@Nonnull
@CheckReturnValue
M moveAbove(@Nonnull
 T other)

Moves the currently selected entity above the specified target entity.

Parameters:

other - The reference entity that should end up below the selected entity

Returns:

The current OrderAction sub-implementation instance

Throws:

IllegalStateException - If no entity has been selected yet, use selectPosition(Object)

IllegalArgumentException - If the specified target entity is not managed by this instance or null

See Also:

• moveUp(int)
• moveDown(int)
• moveBelow(Object)

swapPosition

@Nonnull
@CheckReturnValue
M swapPosition(int swapPosition)

Swaps the currently selected entity with the entity located at the specified position. No other entities are affected by this operation.

Parameters:

swapPosition - 0 based index of target position

Returns:

The current OrderAction sub-implementation instance

Throws:

IllegalStateException - If no entity has been selected yet, use selectPosition(Object)

IllegalArgumentException - If the specified position is out-of-bounds

swapPosition

@Nonnull
@CheckReturnValue
M swapPosition(@Nonnull
 T swapEntity)

Swaps the currently selected entity with the specified entity. No other entities are affected by this operation.

Parameters:

swapEntity - Target entity to switch positions with

Returns:

The current OrderAction sub-implementation instance

Throws:

IllegalStateException - If no entity has been selected yet, use selectPosition(Object)

IllegalArgumentException - If the specified position is out-of-bounds, or if the target entity is null or not available in this order action implementation

See Also:

• swapPosition(int)

reverseOrder

@Nonnull
@CheckReturnValue
M reverseOrder()

Reverses the current order by using Collections.reverse(orderList)

Returns:

The current OrderAction sub-implementation instance

See Also:

• Collections.reverse(java.util.List)

shuffleOrder

@Nonnull
@CheckReturnValue
M shuffleOrder()

Shuffles the current order by using Collections.shuffle(orderList)

Returns:

The current OrderAction sub-implementation instance

See Also:

• Collections.shuffle(java.util.List)

sortOrder

@Nonnull
@CheckReturnValue
M sortOrder(@Nonnull
 Comparator<T> comparator)

Sorts the current order based on the specified Comparator by using ArrayList.sort(comparator)

Parameters:

comparator - Comparator used to sort the current order

Returns:

The current OrderAction sub-implementation instance

Throws:

IllegalArgumentException - If the specified comparator is null

See Also:

• ArrayList.sort(java.util.Comparator)