org.anvilpowered.anvil.base.datastore

Class BaseCacheService<TKey,T extends ObjectWithId<TKey>,TDataStore>

java.lang.Object

org.anvilpowered.anvil.base.datastore.BaseComponent<TKey,TDataStore>

org.anvilpowered.anvil.base.datastore.BaseCacheService<TKey,T,TDataStore>

All Implemented Interfaces:

CacheService<TKey,T,TDataStore>, Component<TKey,TDataStore>, StorageService<TKey,T,TDataStore>, BaseStorageService<TKey,T,TDataStore>

public abstract class BaseCacheService<TKey,T extends ObjectWithId<TKey>,TDataStore>
extends BaseComponent<TKey,TDataStore>
implements CacheService<TKey,T,TDataStore>, BaseStorageService<TKey,T,TDataStore>

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.ConcurrentMap<T,java.lang.Long>	cache
protected Registry	registry

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BaseCacheService(DataStoreContext<TKey,TDataStore> dataStoreContext, Registry registry)

Method Summary

Modifier and Type	Method and Description
java.util.List<T>	delete(java.util.function.Predicate<? super T> predicate) Deletes a T from the cache
java.util.Optional<T>	delete(T t) Deletes a T from the cache
java.util.Optional<T>	deleteOne(java.util.function.Predicate<? super T> predicate) Deletes a T from the cache
java.util.concurrent.CompletableFuture<java.lang.Boolean>	deleteOne(TKey id) Attempts to delete a matching document with the provided id
java.util.List<T>	getAll(java.util.function.Predicate<? super T> predicate)
java.util.Set<T>	getAllAsSet()
java.util.concurrent.CompletableFuture<java.util.List<TKey>>	getAllIds()
java.lang.Runnable	getCacheInvalidationTask()
java.util.Optional<T>	getOne(java.util.function.Predicate<? super T> predicate)
java.util.concurrent.CompletableFuture<java.util.Optional<T>>	getOne(TKey id) Attempts to find a matching document with the provided id
java.util.concurrent.CompletableFuture<java.util.List<T>>	insert(java.util.List<T> list)
java.util.concurrent.CompletableFuture<java.util.Optional<T>>	insertOne(T t)

Methods inherited from class org.anvilpowered.anvil.base.datastore.BaseComponent

getDataStoreContext, getTKeyClass, parse

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.anvilpowered.anvil.api.datastore.CacheService

startCacheInvalidationTask, stopCacheInvalidationTask

Methods inherited from interface org.anvilpowered.anvil.base.datastore.BaseStorageService

generateEmpty, parseAndDeleteOne, parseAndGetOne

Methods inherited from interface org.anvilpowered.anvil.api.datastore.StorageService

deleteOne, getAll, getOne, getTClass

Field Detail

registry

protected Registry registry

cache

protected java.util.concurrent.ConcurrentMap<T extends ObjectWithId<TKey>,java.lang.Long> cache

Constructor Detail

BaseCacheService

protected BaseCacheService(DataStoreContext<TKey,TDataStore> dataStoreContext,
                           Registry registry)

Method Detail

getCacheInvalidationTask

public java.lang.Runnable getCacheInvalidationTask()

Specified by:

getCacheInvalidationTask in interface CacheService<TKey,T extends ObjectWithId<TKey>,TDataStore>

Returns:

Cache invalidation task

getAllAsSet

public java.util.Set<T> getAllAsSet()

Specified by:

getAllAsSet in interface CacheService<TKey,T extends ObjectWithId<TKey>,TDataStore>

Returns:

A set containing all parties in the cache

insertOne

public java.util.concurrent.CompletableFuture<java.util.Optional<T>> insertOne(T t)

Specified by:

insertOne in interface StorageService<TKey,T extends ObjectWithId<TKey>,TDataStore>

Parameters:

t - document to insert

Returns:

An Optional containing the inserted document if successful, otherwise Optional.empty()

insert

public java.util.concurrent.CompletableFuture<java.util.List<T>> insert(java.util.List<T> list)

Specified by:

insert in interface StorageService<TKey,T extends ObjectWithId<TKey>,TDataStore>

Parameters:

list - List of documents to insert

Returns:

List of all documents that were successfully inserted

getOne

public java.util.concurrent.CompletableFuture<java.util.Optional<T>> getOne(TKey id)

Description copied from interface: StorageService

Attempts to find a matching document with the provided id

Specified by:

getOne in interface StorageService<TKey,T extends ObjectWithId<TKey>,TDataStore>

Parameters:

id - TKey to query repository with

Returns:

An Optional containing a matching document if successful, otherwise Optional.empty()

deleteOne

public java.util.concurrent.CompletableFuture<java.lang.Boolean> deleteOne(TKey id)

Description copied from interface: StorageService

Attempts to delete a matching document with the provided id

Specified by:

deleteOne in interface StorageService<TKey,T extends ObjectWithId<TKey>,TDataStore>

Parameters:

id - TKey to query repository with

Returns:

Whether or not an item was found and deleted

getAllIds

public java.util.concurrent.CompletableFuture<java.util.List<TKey>> getAllIds()

Specified by:

getAllIds in interface StorageService<TKey,T extends ObjectWithId<TKey>,TDataStore>

Returns:

A List of all ids in the repository

deleteOne

public java.util.Optional<T> deleteOne(java.util.function.Predicate<? super T> predicate)

Description copied from interface: CacheService

Deletes a T from the cache

Specified by:

deleteOne in interface CacheService<TKey,T extends ObjectWithId<TKey>,TDataStore>

Parameters:

predicate - of T to remove from cache

Returns:

An optional containing the T if it was successfully removed

delete

public java.util.Optional<T> delete(T t)

Description copied from interface: CacheService

Deletes a T from the cache

Specified by:

delete in interface CacheService<TKey,T extends ObjectWithId<TKey>,TDataStore>

Parameters:

t - T to remove from cache

Returns:

An optional containing the T if it was successfully removed

delete

public java.util.List<T> delete(java.util.function.Predicate<? super T> predicate)

Description copied from interface: CacheService

Deletes a T from the cache

Specified by:

delete in interface CacheService<TKey,T extends ObjectWithId<TKey>,TDataStore>

Parameters:

predicate - of T to remove from cache

Returns:

A list of successfully deleted elements

getAll

public java.util.List<T> getAll(java.util.function.Predicate<? super T> predicate)

Specified by:

getAll in interface CacheService<TKey,T extends ObjectWithId<TKey>,TDataStore>

getOne

public java.util.Optional<T> getOne(java.util.function.Predicate<? super T> predicate)

Specified by:

getOne in interface CacheService<TKey,T extends ObjectWithId<TKey>,TDataStore>