io.micronaut.data.repository.reactive

Interface RxJavaCrudRepository<E,ID>

Type Parameters:

E - The entity type

ID - The ID type

All Superinterfaces:

GenericRepository<E,ID>

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

Interface for CRUD using RxJava 2.

Since:

1.0.0

Author:

graemerocher

Method Summary

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

Method Detail

save

@NonNull
<S extends E> io.reactivex.Single<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> io.reactivex.Flowable<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.

findById

@NonNull
io.reactivex.Maybe<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.

update

@NonNull
<S extends E> io.reactivex.Single<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 update. Must not be null.

Returns:

The updated entity will never be null.

Throws:

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

updateAll

@NonNull
<S extends E> io.reactivex.Flowable<S> updateAll(@Valid @NotNull @NonNull
                                                          @Valid @NotNull java.lang.Iterable<S> entities)

This method issues an explicit update for the given entities. The method differs from saveAll(Iterable) 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:

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

Returns:

The updated entities will never be null.

Throws:

javax.validation.ConstraintViolationException - if entities is null or invalid.

existsById

@NonNull
io.reactivex.Single<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
io.reactivex.Flowable<E> findAll()

Returns all instances of the type.

Returns:

all entities

count

@NonNull
io.reactivex.Single<java.lang.Long> count()

Returns the number of entities available.

Returns:

the number of entities

deleteById

@NonNull
io.reactivex.Completable 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

@NonNull
io.reactivex.Completable 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

@NonNull
io.reactivex.Completable 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
io.reactivex.Completable deleteAll()

Deletes all entities managed by the repository.

Returns:

A future that executes the delete operation