au.com.mountainpass.hyperstate.core

Interface EntityRepository

All Superinterfaces:

org.springframework.data.repository.Repository<EntityWrapper<?>,java.lang.String>

public interface EntityRepository
extends org.springframework.data.repository.Repository<EntityWrapper<?>,java.lang.String>

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.CompletableFuture<DeletedEntity>	delete(EntityWrapper<?> entity) Deletes a given entity.
java.util.concurrent.CompletableFuture<DeletedEntity>	delete(java.lang.String id) Deletes the entity with the given id.
java.util.concurrent.CompletableFuture<java.lang.Void>	deleteAll()
java.util.concurrent.CompletableFuture<java.lang.Boolean>	exists(java.lang.String id) Returns whether an entity with the given id exists.
java.util.concurrent.CompletableFuture<EntityWrapper<?>>	findOne(java.lang.String id) Retrieves an entity by its id.
<S extends EntityWrapper<?>> java.util.concurrent.CompletableFuture<S>	findOne(java.lang.String path, java.lang.Class<S> type)
<S extends EntityWrapper<?>> java.util.concurrent.CompletableFuture<S>	save(S entity) Saves a given entity.

Method Detail

delete

@Async
java.util.concurrent.CompletableFuture<DeletedEntity> delete(EntityWrapper<?> entity)

Deletes a given entity.

Parameters:

entity - the entity to deleted

Returns:

And empty future to allow execution when the delete completes.

Throws:

java.lang.IllegalArgumentException - in case the given entity is null.

delete

@Async
java.util.concurrent.CompletableFuture<DeletedEntity> delete(java.lang.String id)

Deletes the entity with the given id.

Parameters:

id - must not be null.

Returns:

And empty future to allow execution when the delete completes.

Throws:

java.lang.IllegalArgumentException - in case the given id is null

exists

@Async
java.util.concurrent.CompletableFuture<java.lang.Boolean> exists(java.lang.String id)

Returns whether an entity with the given id exists.

Parameters:

id - must not be null.

Returns:

true if an entity with the given id exists, false otherwise

Throws:

java.lang.IllegalArgumentException - if id is null

findOne

@Async
java.util.concurrent.CompletableFuture<EntityWrapper<?>> findOne(java.lang.String id)

Retrieves an entity by its id.

Parameters:

id - must not be null.

Returns:

the entity with the given id or null if none found

Throws:

java.lang.IllegalArgumentException - if id is null

findOne

@Async
<S extends EntityWrapper<?>> java.util.concurrent.CompletableFuture<S> findOne(java.lang.String path,
                                                                                      java.lang.Class<S> type)

save

@Async
<S extends EntityWrapper<?>> java.util.concurrent.CompletableFuture<S> save(S entity)

Saves a given entity. Use the returned instance for further operations as the save operation might have changed the entity instance completely.

Type Parameters:

S - the type of the entity being saved

Parameters:

entity - The entity to be saved.

Returns:

the saved entity

deleteAll

@Async
java.util.concurrent.CompletableFuture<java.lang.Void> deleteAll()