discord4j.store.api.util

Class StoreContext

java.lang.Object

discord4j.store.api.util.StoreContext

public class StoreContext
extends Object

This is a simple context object, containing various information about the environment the store is being invoked in.

Constructor Summary

Constructors

Constructor and Description
StoreContext(int shard, Class<?> messageClass)

Method Summary

Modifier and Type	Method and Description
Class<?>	getMessageClass() This gets the message class used by the client.
int	getShard() This gets the shard index which the client is currently operating on.

Methods inherited from class java.lang.Object

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

Constructor Detail

StoreContext

public StoreContext(int shard,
                    Class<?> messageClass)

Method Detail

getShard

public int getShard()

This gets the shard index which the client is currently operating on.

Returns:

The shard id.

getMessageClass

public Class<?> getMessageClass()

This gets the message class used by the client. It may be useful to occasionally evict objects of this type from their respective stores due to the high likelihood of unbounded memory usage leading to eventual OutOfMemoryErrors.

Returns:

The class which represents a message.