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

Class OrderActionImpl<T,M extends OrderAction<T,M>>

java.lang.Object

net.dv8tion.jda.internal.requests.RestActionImpl<Void>

net.dv8tion.jda.internal.requests.restaction.order.OrderActionImpl<T,M>

All Implemented Interfaces:

RestAction<Void>, OrderAction<T,M>

Direct Known Subclasses:

ChannelOrderActionImpl, RoleOrderActionImpl

public abstract class OrderActionImpl<T,M extends OrderAction<T,M>>
extends RestActionImpl<Void>
implements OrderAction<T,M>

Field Summary

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

LOG

Constructor Summary

Constructors

Constructor	Description
OrderActionImpl(JDA api, boolean ascendingOrder, Route.CompiledRoute route)	Creates a new OrderAction instance
OrderActionImpl(JDA api, Route.CompiledRoute route)	Creates a new OrderAction instance

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.
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 OrderAction.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 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 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

OrderActionImpl

public OrderActionImpl(JDA api,
 Route.CompiledRoute route)

Creates a new OrderAction instance

Parameters:

api - JDA instance which is associated with the entities contained in the order list

route - The CompiledRoute which is provided to the RestAction Constructor

OrderActionImpl

public OrderActionImpl(JDA api,
 boolean ascendingOrder,
 Route.CompiledRoute route)

Creates a new OrderAction instance

Parameters:

api - JDA instance which is associated with the entities contained in the order list

ascendingOrder - Whether or not the order of items should be ascending

route - The CompiledRoute which is provided to the RestAction Constructor

Method Details

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 OrderAction<T,M extends OrderAction<T,M>>

Specified by:

setCheck in interface RestAction<T>

Overrides:

setCheck in class RestActionImpl<Void>

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 OrderAction<T,M extends OrderAction<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 OrderAction<T,M extends OrderAction<T,M>>

Specified by:

deadline in interface RestAction<T>

Overrides:

deadline in class RestActionImpl<Void>

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

public boolean isAscendingOrder()

Description copied from interface: OrderAction

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

Specified by:

isAscendingOrder in interface OrderAction<T,M extends OrderAction<T,M>>

Returns:

True, if this uses ascending order

getCurrentOrder

@Nonnull
public List<T> getCurrentOrder()

Description copied from interface: OrderAction

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

Specified by:

getCurrentOrder in interface OrderAction<T,M extends OrderAction<T,M>>

Returns:

Immutable List representing the current order

selectPosition

@Nonnull
public M selectPosition(int selectedPosition)

Description copied from interface: OrderAction

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

Specified by:

selectPosition in interface OrderAction<T,M extends OrderAction<T,M>>

Parameters:

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

Returns:

The current OrderAction sub-implementation instance

See Also:

• OrderAction.getSelectedPosition()
• OrderAction.getSelectedEntity()

selectPosition

@Nonnull
public M selectPosition(@Nonnull
 T selectedEntity)

Description copied from interface: OrderAction

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

Specified by:

selectPosition in interface OrderAction<T,M extends OrderAction<T,M>>

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:

• OrderAction.selectPosition(int)
• OrderAction.getSelectedPosition()
• OrderAction.getSelectedEntity()

getSelectedPosition

public int getSelectedPosition()

Description copied from interface: OrderAction

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

Specified by:

getSelectedPosition in interface OrderAction<T,M extends OrderAction<T,M>>

Returns:

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

getSelectedEntity

@Nonnull
public T getSelectedEntity()

Description copied from interface: OrderAction

The entity which is currently at the selected position

Specified by:

getSelectedEntity in interface OrderAction<T,M extends OrderAction<T,M>>

Returns:

The currently selected entity

moveUp

@Nonnull
public M moveUp(int amount)

Description copied from interface: OrderAction

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

Specified by:

moveUp in interface OrderAction<T,M extends OrderAction<T,M>>

Parameters:

amount - The amount of positions that should be moved

Returns:

The current OrderAction sub-implementation instance

See Also:

• OrderAction.moveTo(int)

moveDown

@Nonnull
public M moveDown(int amount)

Description copied from interface: OrderAction

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

Specified by:

moveDown in interface OrderAction<T,M extends OrderAction<T,M>>

Parameters:

amount - The amount of positions that should be moved

Returns:

The current OrderAction sub-implementation instance

See Also:

• OrderAction.moveTo(int)

moveTo

@Nonnull
public M moveTo(int position)

Description copied from interface: OrderAction

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.

Specified by:

moveTo in interface OrderAction<T,M extends OrderAction<T,M>>

Parameters:

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

Returns:

The current OrderAction sub-implementation instance

See Also:

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

moveBelow

@Nonnull
public M moveBelow(@Nonnull
 T other)

Description copied from interface: OrderAction

Moves the currently selected entity below the specified target entity.

Specified by:

moveBelow in interface OrderAction<T,M extends OrderAction<T,M>>

Parameters:

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

Returns:

The current OrderAction sub-implementation instance

See Also:

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

moveAbove

@Nonnull
public M moveAbove(@Nonnull
 T other)

Description copied from interface: OrderAction

Moves the currently selected entity above the specified target entity.

Specified by:

moveAbove in interface OrderAction<T,M extends OrderAction<T,M>>

Parameters:

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

Returns:

The current OrderAction sub-implementation instance

See Also:

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

swapPosition

@Nonnull
public M swapPosition(int swapPosition)

Description copied from interface: OrderAction

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

Specified by:

swapPosition in interface OrderAction<T,M extends OrderAction<T,M>>

Parameters:

swapPosition - 0 based index of target position

Returns:

The current OrderAction sub-implementation instance

swapPosition

@Nonnull
public M swapPosition(@Nonnull
 T swapEntity)

Description copied from interface: OrderAction

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

Specified by:

swapPosition in interface OrderAction<T,M extends OrderAction<T,M>>

Parameters:

swapEntity - Target entity to switch positions with

Returns:

The current OrderAction sub-implementation instance

See Also:

• OrderAction.swapPosition(int)

reverseOrder

@Nonnull
public M reverseOrder()

Description copied from interface: OrderAction

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

Specified by:

reverseOrder in interface OrderAction<T,M extends OrderAction<T,M>>

Returns:

The current OrderAction sub-implementation instance

See Also:

• Collections.reverse(java.util.List)

shuffleOrder

@Nonnull
public M shuffleOrder()

Description copied from interface: OrderAction

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

Specified by:

shuffleOrder in interface OrderAction<T,M extends OrderAction<T,M>>

Returns:

The current OrderAction sub-implementation instance

See Also:

• Collections.shuffle(java.util.List)

sortOrder

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

Description copied from interface: OrderAction

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

Specified by:

sortOrder in interface OrderAction<T,M extends OrderAction<T,M>>

Parameters:

comparator - Comparator used to sort the current order

Returns:

The current OrderAction sub-implementation instance

See Also:

• ArrayList.sort(java.util.Comparator)