discord4j.store.api.primitive

Class ForwardingStoreService

java.lang.Object

discord4j.store.api.primitive.ForwardingStoreService

All Implemented Interfaces:

StoreService

public class ForwardingStoreService
extends Object
implements StoreService

An implementation of StoreService which creates primitive stores which delegate to another, generic store.

See Also:

StoreService

Constructor Summary

Constructors

Constructor and Description
ForwardingStoreService(StoreService toForward) Constructs the service.

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).
StoreService	getOriginal() Gets the original, generic capable, service.
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.
int	order() Returns an arbitrary order for this service.
<K extends Comparable<K>,V extends Serializable> Store<K,V>	provideGenericStore(Class<K> keyClass, Class<V> valueClass) This is called to provide a new store instance for the provided configuration.
<V extends Serializable> 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

Constructor Detail

ForwardingStoreService

public ForwardingStoreService(StoreService toForward)

Constructs the service.

Parameters:

toForward - The generic store service to forward to.

Method Detail

getOriginal

public StoreService getOriginal()

Gets the original, generic capable, service.

Returns:

The service being forwarded to.

order

public int order()

Description copied from interface: StoreService

Returns an arbitrary order for this service. This is used for automated service discovery in the case that multiple services are present. Conventions: 0 = neutral priority, Integer.MAX_VALUE = lowest priority, Integer.MIN_VALUE = highest priority.

Specified by:

order in interface StoreService

Returns:

The priority of this service, 0 by default.

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 extends Serializable> 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 extends Serializable> 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.