Package io.micronaut.data.repository

Interface CrudRepository<E,ID>

Type Parameters:
E - The entity type
ID - The ID type
All Superinterfaces:
GenericRepository<E,ID>
All Known Subinterfaces:
JpaRepository<E,ID>, PageableRepository<E,ID>
public interface CrudRepository<E,ID> extends GenericRepository<E,ID>
A repository interface for performing CRUD (Create, Read, Update, Delete). This is a blocking variant and is largely based on the same interface in Spring Data, however includes integrated validation support.
Since:
1.0
Author:
graemerocher

  • Method Summary

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

  • Method Details

    • save

      @NonNull <S extends E> S save(@NonNull S entity)
      Saves the given valid entity, returning a possibly new entity representing the saved state. Note that certain implementations may not be able to detect whether a save or update should be performed and may always perform an insert. The update(Object) method can be used in this case to explicitly request an update.
      Type Parameters:
      S - The generic type
      Parameters:
      entity - The entity to save. Must not be null.
      Returns:
      The saved entity will never be null.

    • update

      @NonNull <S extends E> S update(@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 updated entity will never be null.

    • updateAll

      @NonNull <S extends E> @NonNull List<S> updateAll(@NonNull @NonNull 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.

    • saveAll

      @NonNull <S extends E> @NonNull List<S> saveAll(@NonNull @NonNull 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 save. Must not be null.
      Returns:
      The saved entities objects. will never be null.

    • findById

      @NonNull @NonNull Optional<E> findById(@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

    • existsById

      boolean existsById(@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.

    • findAll

      @NonNull @NonNull List<E> findAll()
      Returns all instances of the type.
      Returns:
      all entities

    • count

      long count()
      Returns the number of entities available.
      Returns:
      the number of entities

    • deleteById

      void deleteById(@NonNull ID id)
      Deletes the entity with the given id.
      Parameters:
      id - must not be null.

    • delete

      void delete(@NonNull E entity)
      Deletes a given entity.
      Parameters:
      entity - The entity to delete

    • deleteAll

      void deleteAll(@NonNull @NonNull Iterable<? extends E> entities)
      Deletes the given entities.
      Parameters:
      entities - The entities to delete

    • deleteAll

      void deleteAll()
      Deletes all entities managed by the repository.