io.micronaut.data.repository.reactive

Interface ReactiveStreamsCrudRepository<E,ID>

Type Parameters:

E - The entity type

ID - The ID type

All Superinterfaces:

GenericRepository<E,ID>

public interface ReactiveStreamsCrudRepository<E,ID>
extends GenericRepository<E,ID>

Interface for CRUD using Reactive Streams.

Since:

1.0.0

Author:

graemerocher

Method Summary

Modifier and Type	Method and Description
org.reactivestreams.Publisher<java.lang.Long>	count() Returns the number of entities available.
org.reactivestreams.Publisher<java.lang.Long>	delete(E entity) Deletes a given entity.
org.reactivestreams.Publisher<java.lang.Long>	deleteAll() Deletes all entities managed by the repository.
org.reactivestreams.Publisher<java.lang.Long>	deleteAll(@NotNull java.lang.Iterable<? extends E> entities) Deletes the given entities.
org.reactivestreams.Publisher<java.lang.Long>	deleteById(ID id) Deletes the entity with the given id.
org.reactivestreams.Publisher<java.lang.Boolean>	existsById(ID id) Returns whether an entity with the given id exists.
org.reactivestreams.Publisher<E>	findAll() Returns all instances of the type.
org.reactivestreams.Publisher<E>	findById(ID id) Retrieves an entity by its id.
<S extends E> org.reactivestreams.Publisher<S>	save(S entity) Saves the given valid entity, returning a possibly new entity representing the saved state.
<S extends E> org.reactivestreams.Publisher<S>	saveAll(@Valid @NotNull java.lang.Iterable<S> entities) Saves all given entities, possibly returning new instances representing the saved state.
<S extends E> org.reactivestreams.Publisher<S>	update(S entity) This method issues an explicit update for the given entity.

Method Detail

save

@NonNull
 @SingleResult
<S extends E> org.reactivestreams.Publisher<S> save(@Valid @NotNull @NonNull
                                                                            S entity)

Saves the given valid entity, returning a possibly new entity representing the saved state.

Type Parameters:

S - The generic type

Parameters:

entity - The entity to save. Must not be null.

Returns:

The saved entity will never be null.

Throws:

javax.validation.ConstraintViolationException - if the entity is null or invalid.

saveAll

@NonNull
<S extends E> org.reactivestreams.Publisher<S> saveAll(@Valid @NotNull @NonNull
                                                                @Valid @NotNull java.lang.Iterable<S> entities)

Saves all given entities, possibly returning new instances representing the saved state.

Type Parameters:

S - The generic type

Parameters:

entities - The entities to saved. Must not be null.

Returns:

The saved entities objects. will never be null.

Throws:

javax.validation.ConstraintViolationException - if the entities are null.

update

@NonNull
<S extends E> org.reactivestreams.Publisher<S> update(@Valid @NotNull @NonNull
                                                               S entity)

This method issues an explicit update for the given entity. The method differs from save(Object) in that an update will be generated regardless if the entity has been saved previously or not. If the entity has no assigned ID then an exception will be thrown.

Type Parameters:

S - The generic type

Parameters:

entity - The entity to save. Must not be null.

Returns:

The saved entity will never be null.

Throws:

javax.validation.ConstraintViolationException - if the entity is null or invalid.

findById

@NonNull
 @SingleResult
org.reactivestreams.Publisher<E> findById(@NotNull @NonNull
                                                                  ID id)

Retrieves an entity by its id.

Parameters:

id - The ID of the entity to retrieve. Must not be null.

Returns:

the entity with the given id or Optional#empty() if none found

Throws:

javax.validation.ConstraintViolationException - if the id is null.

existsById

@SingleResult
 @NonNull
org.reactivestreams.Publisher<java.lang.Boolean> existsById(@NotNull @NonNull
                                                                                    ID 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:

javax.validation.ConstraintViolationException - if the id is null.

findAll

@NonNull
org.reactivestreams.Publisher<E> findAll()

Returns all instances of the type.

Returns:

all entities

count

@SingleResult
 @NonNull
org.reactivestreams.Publisher<java.lang.Long> count()

Returns the number of entities available.

Returns:

the number of entities

deleteById

@NonNull
 @SingleResult
org.reactivestreams.Publisher<java.lang.Long> deleteById(@NonNull @NotNull
                                                                                 ID id)

Deletes the entity with the given id.

Parameters:

id - must not be null.

Returns:

A future that executes the delete operation

Throws:

javax.validation.ConstraintViolationException - if the entity is null.

delete

@SingleResult
 @NonNull
org.reactivestreams.Publisher<java.lang.Long> delete(@NonNull @NotNull
                                                                             E entity)

Deletes a given entity.

Parameters:

entity - The entity to delete

Returns:

A future that executes the delete operation

Throws:

javax.validation.ConstraintViolationException - if the entity is null.

deleteAll

@SingleResult
 @NonNull
org.reactivestreams.Publisher<java.lang.Long> deleteAll(@NonNull @NotNull
                                                                                @NotNull java.lang.Iterable<? extends E> entities)

Deletes the given entities.

Parameters:

entities - The entities to delete

Returns:

A future that executes the delete operation

Throws:

javax.validation.ConstraintViolationException - if the entity is null.

deleteAll

@NonNull
org.reactivestreams.Publisher<java.lang.Long> deleteAll()

Deletes all entities managed by the repository.

Returns:

A future that executes the delete operation