Predefined methods

All predefined methods of the default repository.

Each repository has predefined methods which are supported by default. Here is a representation of the repository interface showing the predefined methods.

• The generic type E is the entity of the repository.

• The generic type ID is the unique identifier of the entity.

/**
 * The default Repository interface, which predefines several useful methods.
 * See documentation: <a href="https://koboo.gitbook.io/en2do/methods/predefined-methods">...</a>
 * See documentation: <a href="https://koboo.gitbook.io/en2do/get-started/create-the-repository">...</a>
 *
 * @param <E>  The generic type of the Entity
 * @param <ID> The generic type of the field annotated with "@Id" in the Entity
 */
@SuppressWarnings("unused")
public interface Repository<E, ID> {

    /**
     * This method counts all documents of the collection in the mongodb.
     *
     * @return The amount of total entities in this repository.
     */
    long countAll();

    /**
     * This method deletes the given entity, by filtering with the entity's "@Id" field/unique identifier.
     *
     * @param entity The entity, which should be deleted.
     * @return true, if the entity was deleted successfully.
     */
    boolean delete(@NotNull E entity);

    /**
     * This method deletes all entities of the given list, filtering like the "#delete(E entity)" method.
     *
     * @param entityList The List with the entities, which should be deleted.
     * @return true, if all entities were deleted successfully.
     */
    boolean deleteAll(@NotNull List<E> entityList);

    /**
     * This method deletes the entity with the given identifier, filtering like the "#delete(E entity)" method.
     *
     * @param identifier The unique identifier of the entity, which should be deleted.
     * @return true, if the entity was deleted successfully.
     */
    boolean deleteById(@NotNull ID identifier);

    /**
     * Drops / deletes all entities of the repository.
     *
     * @return true, if all entities were deleted successfully.
     */
    boolean drop();

    /**
     * Checks if the given entity exists in the repository, by filtering with the entity's
     * "@Id" field/unique identifier.
     *
     * @param entity The entity, which should be checked.
     * @return true, if the entity exists in the collection.
     */
    boolean exists(@NotNull E entity);

    /**
     * Checks if an entity with the given unique identifier exists in the repository, like the "#exists(E entity)" method.
     *
     * @param identifier The identifier of the entity, which should be checked.
     * @return true, if an entity with the given identifier exists in the collection.
     */
    boolean existsById(@NotNull ID identifier);

    /**
     * Finds all entities of the collection
     *
     * @return A List with all entities of the repository.
     */
    List<E> findAll();

    /**
     * Find the first entity with the given unique identifier.
     * If the entity is not found, "null" is returned.
     *
     * @param identifier The unique identifier of the entity, which is used to filter.
     * @return The found entity, if it exists, or "null" if it not exists.
     */
    @Nullable
    E findFirstById(@NotNull ID identifier);

    /**
     * @return The collection name, defined by the "@Collection" annotation of the repository.
     */
    @NotNull
    String getCollectionName();

    /**
     * @return The Class of the entity of the repository.
     */
    @NotNull
    Class<E> getEntityClass();

    /**
     * @return The Class of the unique identifier of the entity of the repository.
     */
    @NotNull
    Class<ID> getEntityUniqueIdClass();

    /**
     * This method is used to get the unique identifier of the given entity.
     * If the entity doesn't have a unique identifier, a NullPointerException is thrown.
     *
     * @param entity The entity, which unique identifier, should be returned
     * @return The unique identifier of the given entity.
     */
    @Nullable
    ID getUniqueId(@NotNull E entity);

    /**
     * This method applies the pagination of all entities of the repository.
     *
     * @param pagination The pagination, which is used to page the entities.
     * @return A List with the paged entities.
     */
    @NotNull
    List<E> pageAll(@NotNull Pagination pagination);

    /**
     * Saves the given entity to the database.
     * If the entity exists, the existing document is updated.
     * If the entity doesn't exist, a new document is created.
     *
     * @param entity The entity, which should be saved.
     * @return true, if the entity was successfully saved.
     */
    boolean save(@NotNull E entity);

    /**
     * Saves all entities of the given List to the database.
     *
     * @param entityList A List of the entities, which should be saved
     * @return true, if the entities were successfully saved.
     */
    boolean saveAll(@NotNull List<E> entityList);

    /**
     * This method applies the Sort object of all entities of the repository.
     *
     * @param sort The Sort object, which should be used to sort all entities.
     * @return A List with the sorted entities.
     */
    @NotNull
    List<E> sortAll(@NotNull Sort sort);

    /**
     * This method uses the UpdateBatch object to update the fields of all documents.
     *
     * @param updateBatch The UpdateBatch to use.
     * @return true, if the operation was successful.
     */
    boolean updateAllFields(UpdateBatch updateBatch);
}