Package org.javacord.api.entity

Interface UpdatableFromCache<T extends DiscordEntity>

All Superinterfaces:

Updatable<T>

All Known Subinterfaces:

Channel, ChannelCategory, CustomEmoji, GroupChannel, KnownCustomEmoji, Message, PrivateChannel, Role, Server, ServerChannel, ServerTextChannel, ServerVoiceChannel, TextChannel, User, VoiceChannel

public interface UpdatableFromCache<T extends DiscordEntity>
extends Updatable<T>

This class represents an entity which is updatable from cache.

Method Summary

Modifier and Type	Method	Description
Optional<T>	getCurrentCachedInstance()	Gets an updated instance of this entity from the cache.
default CompletableFuture<T>	getLatestInstance()	Gets an updated instance of this entity from the cache or from Discord directly.

Method Detail

getCurrentCachedInstance

Optional<T> getCurrentCachedInstance()

Gets an updated instance of this entity from the cache. This is for example necessary if an instance got invalid by a reconnect to Discord which invalidates all existing instances which means they do not get any further updates from Discord applied. Due to that, references to instances should usually not be held for an extended period of time. If they are, this method can be used to retrieve the current instance from the cache, that gets updates from Discord, in case this one was invalidated.

This method returns the currently cached entity, or an empty Optional if the entity is not cached any longer, for example because it was deleted or the message was thrown out of the cache.

Returns:

The current cached instance.

getLatestInstance

default CompletableFuture<T> getLatestInstance()

Description copied from interface: Updatable

Gets an updated instance of this entity from the cache or from Discord directly. This is for example necessary if an instance got invalid by a reconnect to Discord which invalidates all existing instances which means they do not get any further updates from Discord applied. Due to that, references to instances should usually not be held for an extended period of time. If they are, this method can be used to retrieve the current instance from the cache if present or from Discord directly.

This method returns the currently cached entity if present, or request the entity from Discord if it is not cached or not permanently cached. If the entity is a fully cached entity and is not in the cache any longer, for example because it was deleted or the message was thrown out of the cache, the CompletableFuture completes exceptionally with a NoSuchElementException. If a request to Discord is made, the according remote call exception will be used to complete the CompletableFuture exceptionally.

Specified by:

getLatestInstance in interface Updatable<T extends DiscordEntity>

Returns:

The current cached instance.