discord4j.store.api.readonly

Class ReadOnlyStoreService

java.lang.Object

discord4j.store.api.readonly.ReadOnlyStoreService

All Implemented Interfaces:

StoreService

public class ReadOnlyStoreService
extends Object
implements StoreService

StoreService decorator disabling all writing operations, effectively working as a read-only store.

Constructor Summary

Constructors

Constructor and Description
ReadOnlyStoreService(StoreService delegate) Create a new ReadOnlyStoreService for the given StoreService.

Method Summary

Modifier and Type	Method and Description
Mono<Void>	dispose() This is a lifecycle method called to signal that a store should dispose of any resources due to an abrupt close (hard reconnect or disconnect).
boolean	hasGenericStores() This is used to check if this service can provide generic stores.
boolean	hasLongObjStores() This is used to check if this service can provide long-object stores.
void	init(StoreContext context) This is a lifecycle method called to signal that a store should allocate any necessary resources.
<K extends Comparable<K>,V> Store<K,V>	provideGenericStore(Class<K> keyClass, Class<V> valueClass) This is called to provide a new store instance for the provided configuration.
<V> LongObjStore<V>	provideLongObjStore(Class<V> valueClass) This is called to provide a new store instance with a long key and object values.

Methods inherited from class java.lang.Object

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

Methods inherited from interface discord4j.store.api.service.StoreService

order

Constructor Detail

ReadOnlyStoreService

public ReadOnlyStoreService(StoreService delegate)

Create a new ReadOnlyStoreService for the given StoreService.

Parameters:

delegate - the delegate service

Method Detail

hasGenericStores

public boolean hasGenericStores()

Description copied from interface: StoreService

This is used to check if this service can provide generic stores.

Specified by:

hasGenericStores in interface StoreService

Returns:

True if possible, else false.

See Also:

Store

provideGenericStore

public <K extends Comparable<K>,V> Store<K,V> provideGenericStore(Class<K> keyClass,
                                                                  Class<V> valueClass)

Description copied from interface: StoreService

This is called to provide a new store instance for the provided configuration.

Specified by:

provideGenericStore in interface StoreService

Type Parameters:

K - The key type which provides a 1:1 mapping to the value type. This type is also expected to be Comparable in order to allow for range operations.

V - The value type, these follow JavaBean conventions.

Parameters:

keyClass - The class of the keys.

valueClass - The class of the values.

Returns:

The instance of the store.

hasLongObjStores

public boolean hasLongObjStores()

Description copied from interface: StoreService

This is used to check if this service can provide long-object stores.

Specified by:

hasLongObjStores in interface StoreService

Returns:

True if possible, else false.

See Also:

LongObjStore

provideLongObjStore

public <V> LongObjStore<V> provideLongObjStore(Class<V> valueClass)

Description copied from interface: StoreService

This is called to provide a new store instance with a long key and object values.

Specified by:

provideLongObjStore in interface StoreService

Type Parameters:

V - The value type, these follow JavaBean conventions.

Parameters:

valueClass - The class of the values.

Returns:

The instance of the store.

init

public void init(StoreContext context)

Description copied from interface: StoreService

This is a lifecycle method called to signal that a store should allocate any necessary resources.

Specified by:

init in interface StoreService

Parameters:

context - Some context about the environment which this service is being utilized in.

dispose

public Mono<Void> dispose()

Description copied from interface: StoreService

This is a lifecycle method called to signal that a store should dispose of any resources due to an abrupt close (hard reconnect or disconnect).

Specified by:

dispose in interface StoreService

Returns:

A mono, whose completion signals that resources have been released successfully.