discord4j.store.api

Interface Store<K extends Comparable<K>,V extends Serializable>

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.

All Known Subinterfaces:

LongObjStore<V>

All Known Implementing Classes:

ForwardingStore, NoOpLongObjStore, NoOpStore, ReadOnlyLongObjStore, ReadOnlyStore

public interface Store<K extends Comparable<K>,V extends Serializable>

This provides an active data connection to a store's data source.

See Also:

LongObjStore

Method Summary

Modifier and Type	Method and Description
Mono<Long>	count() Retrieves the amount of stored values in the data source currently.
Mono<Void>	delete(K id) Deletes a value associated with the provided id.
Mono<Void>	delete(Publisher<K> ids) Deletes the values associated with the provided ids.
Mono<Void>	deleteAll() Deletes all entries in the data source.
Mono<Void>	deleteInRange(K start, K end) Deletes values within a range of ids.
default Flux<Tuple2<K,V>>	entries() Gets a stream of all entries in the data source.
Mono<V>	find(K id) Attempts to find the value associated with the provided id.
Flux<V>	findInRange(K start, K end) Retrieves all stored values with ids within a provided range.
Mono<Void>	invalidate() Invalidates the contents of the store.
Flux<K>	keys() Gets a stream of all keys in the data source.
Mono<Void>	save(K key, V value) Stores a key value pair.
Mono<Void>	save(Publisher<Tuple2<K,V>> entryStream) Stores key value pairs.
Flux<V>	values() Gets a stream of all values in the data source.

Method Detail

save

Mono<Void> save(K key,
                V value)

Stores a key value pair.

Parameters:

key - The key representing the value.

value - The value.

Returns:

A mono which signals the completion of the storage of the pair.

save

Mono<Void> save(Publisher<Tuple2<K,V>> entryStream)

Stores key value pairs.

Parameters:

entryStream - A flux providing the key value pairs.

Returns:

A mono which signals the completion of the storage of the pairs.

find

Mono<V> find(K id)

Attempts to find the value associated with the provided id.

Parameters:

id - The id to search with.

Returns:

A mono, which may or may not contain an associated object.

findInRange

Flux<V> findInRange(K start,
                    K end)

Retrieves all stored values with ids within a provided range.

Parameters:

start - The starting key (inclusive).

end - The ending key (exclusive).

Returns:

The stream of values with ids within the provided range.

count

Mono<Long> count()

Retrieves the amount of stored values in the data source currently.

Returns:

A mono which provides the amount of stored values.

delete

Mono<Void> delete(K id)

Deletes a value associated with the provided id.

Parameters:

id - The id of the value to delete.

Returns:

A mono which signals the completion of the deletion of the value.

delete

Mono<Void> delete(Publisher<K> ids)

Deletes the values associated with the provided ids.

Parameters:

ids - A stream of ids to delete values for.

Returns:

A mono which signals the completion of the deletion of the values.

deleteInRange

Mono<Void> deleteInRange(K start,
                         K end)

Deletes values within a range of ids.

Parameters:

start - The starting key (inclusive).

end - The ending key (exclusive).

Returns:

A mono which signals the completion of the deletion of values.

deleteAll

Mono<Void> deleteAll()

Deletes all entries in the data source.

Returns:

A mono which signals the completion of the deletion of all values.

keys

Flux<K> keys()

Gets a stream of all keys in the data source.

Returns:

The stream of keys stored.

values

Flux<V> values()

Gets a stream of all values in the data source.

Returns:

The stream of values stored.

entries

default Flux<Tuple2<K,V>> entries()

Gets a stream of all entries in the data source.

Returns:

The stream of all entries stored.

invalidate

Mono<Void> invalidate()

Invalidates the contents of the store. Once this is invoked, there is no longer a guarantee that the data in the store is reliable.

Returns:

A mono which signals the completion of the invalidation of all values.