discord4j.store.api.readonly

Class ReadOnlyStore<K extends Comparable<K>,V extends Serializable>

java.lang.Object

discord4j.store.api.readonly.ReadOnlyStore<K,V>

Type Parameters:

K - the store keys

V - the store values

All Implemented Interfaces:

Store<K,V>

public class ReadOnlyStore<K extends Comparable<K>,V extends Serializable>
extends Object
implements Store<K,V>

Store implementation that returns Mono.empty() to every writing operation.

Constructor Summary

Constructors

Constructor and Description
ReadOnlyStore(Store<K,V> backing)

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

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.Store

entries

Constructor Detail

ReadOnlyStore

public ReadOnlyStore(Store<K,V> backing)

Method Detail

save

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

Description copied from interface: Store

Stores a key value pair.

Specified by:

save in interface Store<K extends Comparable<K>,V extends Serializable>

Parameters:

key - The key representing the value.

value - The value.

Returns:

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

save

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

Description copied from interface: Store

Stores key value pairs.

Specified by:

save in interface Store<K extends Comparable<K>,V extends Serializable>

Parameters:

entryStream - A flux providing the key value pairs.

Returns:

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

find

public Mono<V> find(K id)

Description copied from interface: Store

Attempts to find the value associated with the provided id.

Specified by:

find in interface Store<K extends Comparable<K>,V extends Serializable>

Parameters:

id - The id to search with.

Returns:

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

findInRange

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

Description copied from interface: Store

Retrieves all stored values with ids within a provided range.

Specified by:

findInRange in interface Store<K extends Comparable<K>,V extends Serializable>

Parameters:

start - The starting key (inclusive).

end - The ending key (exclusive).

Returns:

The stream of values with ids within the provided range.

count

public Mono<Long> count()

Description copied from interface: Store

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

Specified by:

count in interface Store<K extends Comparable<K>,V extends Serializable>

Returns:

A mono which provides the amount of stored values.

delete

public Mono<Void> delete(K id)

Description copied from interface: Store

Deletes a value associated with the provided id.

Specified by:

delete in interface Store<K extends Comparable<K>,V extends Serializable>

Parameters:

id - The id of the value to delete.

Returns:

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

delete

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

Description copied from interface: Store

Deletes the values associated with the provided ids.

Specified by:

delete in interface Store<K extends Comparable<K>,V extends Serializable>

Parameters:

ids - A stream of ids to delete values for.

Returns:

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

deleteInRange

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

Description copied from interface: Store

Deletes values within a range of ids.

Specified by:

deleteInRange in interface Store<K extends Comparable<K>,V extends Serializable>

Parameters:

start - The starting key (inclusive).

end - The ending key (exclusive).

Returns:

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

deleteAll

public Mono<Void> deleteAll()

Description copied from interface: Store

Deletes all entries in the data source.

Specified by:

deleteAll in interface Store<K extends Comparable<K>,V extends Serializable>

Returns:

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

keys

public Flux<K> keys()

Description copied from interface: Store

Gets a stream of all keys in the data source.

Specified by:

keys in interface Store<K extends Comparable<K>,V extends Serializable>

Returns:

The stream of keys stored.

values

public Flux<V> values()

Description copied from interface: Store

Gets a stream of all values in the data source.

Specified by:

values in interface Store<K extends Comparable<K>,V extends Serializable>

Returns:

The stream of values stored.

invalidate

public Mono<Void> invalidate()

Description copied from interface: Store

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

Specified by:

invalidate in interface Store<K extends Comparable<K>,V extends Serializable>

Returns:

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