org.anvilpowered.anvil.api.datastore

Interface StorageService<TKey,T extends ObjectWithId<TKey>,TDataStore>

All Superinterfaces:

Component<TKey,TDataStore>

All Known Subinterfaces:

BaseMongoCachedRepository<T,C>, BaseMongoRepository<T>, BaseStorageService<TKey,T,TDataStore>, BaseXodusCachedRepository<T,C>, BaseXodusRepository<T>, CachedRepository<TKey,T,C,TDataStore>, CacheService<TKey,T,TDataStore>, CoreMemberRepository<TKey,TDataStore>, MongoCoreMemberRepository, MongoRepository<T>, Repository<TKey,T,TDataStore>, SqlRepository<T>, XodusCoreMemberRepository, XodusRepository<T>

All Known Implementing Classes:

BaseCachedRepository, BaseCacheService, BaseRepository

public interface StorageService<TKey,T extends ObjectWithId<TKey>,TDataStore>
extends Component<TKey,TDataStore>

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.CompletableFuture<java.lang.Boolean>	deleteOne(java.time.Instant createdUtc) Attempts to delete the first document where Instant.getEpochSecond() retrieved from ObjectWithId.getCreatedUtc() is equal to Instant.getEpochSecond() of the provided Instant
java.util.concurrent.CompletableFuture<java.lang.Boolean>	deleteOne(TKey id) Attempts to delete a matching document with the provided id
T	generateEmpty()
java.util.concurrent.CompletableFuture<java.util.List<T>>	getAll()
java.util.concurrent.CompletableFuture<java.util.List<TKey>>	getAllIds()
java.util.concurrent.CompletableFuture<java.util.Optional<T>>	getOne(java.time.Instant createdUtc) Attempts to find the first document where Instant.getEpochSecond() retrieved from ObjectWithId.getCreatedUtc() is equal to Instant.getEpochSecond() of the provided Instant
java.util.concurrent.CompletableFuture<java.util.Optional<T>>	getOne(TKey id) Attempts to find a matching document with the provided id
java.lang.Class<T>	getTClass()
java.util.concurrent.CompletableFuture<java.util.List<T>>	insert(java.util.List<T> list)
java.util.concurrent.CompletableFuture<java.util.Optional<T>>	insertOne(T item)
java.util.concurrent.CompletableFuture<java.lang.Boolean>	parseAndDeleteOne(java.lang.Object idOrTime) Attempts to delete a matching document by parsing provided Object.
java.util.concurrent.CompletableFuture<java.util.Optional<T>>	parseAndGetOne(java.lang.Object idOrTime) Attempts to find a matching document by parsing provided Object.

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

getDataStoreContext, getTKeyClass, parse, parseUnsafe

Method Detail

generateEmpty

T generateEmpty()

Returns:

An empty T

getTClass

java.lang.Class<T> getTClass()

insertOne

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

Parameters:

item - document to insert

Returns:

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

insert

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

Parameters:

list - List of documents to insert

Returns:

List of all documents that were successfully inserted

getAllIds

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

Returns:

A List of all ids in the repository

getAll

java.util.concurrent.CompletableFuture<java.util.List<T>> getAll()

Returns:

A List of all documents in the repository

getOne

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

Attempts to find a matching document with the provided id

Parameters:

id - TKey to query repository with

Returns:

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

getOne

java.util.concurrent.CompletableFuture<java.util.Optional<T>> getOne(java.time.Instant createdUtc)

Attempts to find the first document where Instant.getEpochSecond() retrieved from ObjectWithId.getCreatedUtc() is equal to Instant.getEpochSecond() of the provided Instant

Parameters:

createdUtc - Instant to query repository with

Returns:

An Optional containing if successful, otherwise Optional.empty()

parseAndGetOne

java.util.concurrent.CompletableFuture<java.util.Optional<T>> parseAndGetOne(java.lang.Object idOrTime)

Attempts to find a matching document by parsing provided Object.

Will first attempt to parse the provided Object as an id. If parsing is successful, will return the result of getOne(Object).

If parsing as an id is unsuccessful, will attempt to parse the provided Object as createdUtc. If parsing is successful, will return the result of getOne(Instant)

Note: if id parsing is successful but no document is found, will not attempt to parse as time

Parameters:

idOrTime - Object to parse. Can be an actual instance of TKey or a String representation. Can also be wrapped in an Optional

Returns:

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

See Also:

Component.parseUnsafe(Object), Component.parse(Object), TimeFormatService.parseInstantUnsafe(String), TimeFormatService.parseInstant(String)

deleteOne

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

Attempts to delete a matching document with the provided id

Parameters:

id - TKey to query repository with

Returns:

Whether or not an item was found and deleted

deleteOne

java.util.concurrent.CompletableFuture<java.lang.Boolean> deleteOne(java.time.Instant createdUtc)

Attempts to delete the first document where Instant.getEpochSecond() retrieved from ObjectWithId.getCreatedUtc() is equal to Instant.getEpochSecond() of the provided Instant

Parameters:

createdUtc - Instant to query repository with

Returns:

Whether a document was found and deleted

parseAndDeleteOne

java.util.concurrent.CompletableFuture<java.lang.Boolean> parseAndDeleteOne(java.lang.Object idOrTime)

Attempts to delete a matching document by parsing provided Object.

Will first attempt to parse the provided Object as an id. If parsing is successful, will return the result of deleteOne(Object).

If parsing as an id is unsuccessful, will attempt to parse the provided Object as createdUtc. If parsing is successful, will return the result of deleteOne(Instant)

Note: if id parsing is successful but no document is found, will not attempt to parse as time

Parameters:

idOrTime - Object to parse. Can be an actual instance of TKey or a String representation. Can also be wrapped in an Optional

Returns:

Whether a document was found and deleted

See Also:

Component.parseUnsafe(Object), Component.parse(Object), TimeFormatService.parseInstantUnsafe(String), TimeFormatService.parseInstant(String)