com.moon.spring.data.jpa.repository.BaseRepository Maven / Gradle / Ivy
package com.moon.spring.data.jpa.repository;
import com.moon.data.accessor.BaseAccessor;
import com.moon.spring.data.jpa.JpaRecord;
import org.springframework.dao.IncorrectResultSizeDataAccessException;
import org.springframework.data.domain.*;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.repository.NoRepositoryBean;
import javax.persistence.EntityManager;
import javax.persistence.EntityNotFoundException;
import java.util.List;
import java.util.Optional;
import java.util.function.Supplier;
/**
* @author moonsky
*/
@SuppressWarnings("all")
@NoRepositoryBean
public interface BaseRepository, ID> extends JpaRepository, BaseAccessor {
/**
* Always insert a given entity
*
* @param entity must not be {@literal null}.
*
* @return the saved entity; will never be {@literal null}.
*
* @throws IllegalArgumentException in case the given {@literal entity} is {@literal null}.
*/
@Override
S insert(S entity);
/**
* 保存
*
* @param first 将要保存的对象
* @param second 将要保存的对象
* @param entities 将要保存的对象
*
* @return 保存后的对象
*/
@Override
List saveAll(T first, T second, T... entities);
/**
* 下一页切片
*
* @param pageable 分页
*
* @return 所有符合条件的片段，与 page 的区别是，page 会返回总数，这个不需要返回数据总数
*/
@Override
Slice sliceAll(Pageable pageable);
/**
* 下一页切片
*
* @param example
* @param pageable 分页
*
* @return 所有符合条件的片段，与 page 的区别是，page 会返回总数，这个不需要返回数据总数
*/
@Override
Slice sliceAll(Example example, Pageable pageable);
/**
* 查询
*
* @param first ID
* @param second ID
* @param ids ID 列表
*
* @return 符合 ID 的所有对象
*/
@Override
List findAllById(ID first, ID second, ID... ids);
/**
* 查询
*
* @param id ID
*
* @return ID 匹配的对象，不存在是抛出异常
*
* @throws IllegalArgumentException 数据不存在
*/
@Override
T getById(ID id);
/**
* 查询
*
* @param id ID
* @param throwsMessageIfAbsent 异常消息
*
* @return ID 匹配的对象，不存在是抛出异常
*/
@Override
T getById(ID id, String throwsMessageIfAbsent);
/**
* 查询，抛出指定异常
*
* @param id ID
* @param throwIfAbsent 异常
*
* @return ID 匹配的对象，不存在是抛出异常
*
* @throws X 异常
*/
@Override
T getById(ID id, Supplier throwIfAbsent) throws X;
/**
* 查询
*
* @param id ID
*
* @return ID 匹配的对象，不存在时返回 null
*/
@Override
T getOrNull(ID id);
/**
* 删除
*
* @param first 将要删除的对象
* @param second 将要删除的对象
* @param entities 将要删除的对象
*/
@Override
void deleteAll(T first, T second, T... entities);
/**
* 查询
*
* @return 返回所有记录结果
*/
@Override
List findAll();
/**
* 查询
*
* @param sort 排序方式
*
* @return 返回排序后的所有对象
*/
@Override
List findAll(Sort sort);
/**
* 查询
*
* @param ids ID 列表
*
* @return 符合 ID 的所有对象
*/
@Override
List findAllById(Iterable ids);
/**
* 保存
*
* @param entities 将要保存的对象
*
* @return 保存后的对象
*/
@Override
List saveAll(Iterable entities);
/**
* Flushes all pending changes to the database.
*/
@Override
void flush();
/**
* Saves an entity and flushes changes instantly.
*
* @param entity
*
* @return the saved entity
*/
@Override
S saveAndFlush(S entity);
/**
* Deletes the given entities in a batch which means it will create a single {@link Query}. Assume that we will
* clear
* the {@link EntityManager} after the call.
*
* @param entities
*/
@Override
void deleteInBatch(Iterable entities);
/**
* Deletes all entities in a batch call.
*/
@Override
void deleteAllInBatch();
/**
* Returns a reference to the entity with the given identifier. Depending on how the JPA persistence provider is
* implemented this is very likely to always return an instance and throw an
* {@link EntityNotFoundException} on first access. Some of them will reject invalid identifiers
* immediately.
*
* @param id must not be {@literal null}.
*
* @return a reference to the entity with the given identifier.
*
* @see EntityManager#getReference(Class, Object) for details on when an exception is thrown.
*/
@Override
T getOne(ID id);
/**
* 查询符合条件的所有对象
*
* @param example
* @param
*
* @return 符合条件的所有对象
*/
@Override
List findAll(Example example);
/**
* 查询符合条件的所有对象
*
* @param example
* @param sort 排序方式
* @param
*
* @return 符合条件的所有对象
*/
@Override
List findAll(Example example, Sort sort);
/**
* Returns a {@link Page} of entities meeting the paging restriction provided in the {@code Pageable} object.
*
* @param pageable
*
* @return a page of entities
*/
@Override
Page findAll(Pageable pageable);
/**
* Saves a given entity. Use the returned instance for further operations as the save operation might have changed
* the
* entity instance completely.
*
* @param entity must not be {@literal null}.
*
* @return the saved entity; will never be {@literal null}.
*
* @throws IllegalArgumentException in case the given {@literal entity} is {@literal null}.
*/
@Override
S save(S entity);
/**
* Retrieves an entity by its id.
*
* @param id must not be {@literal null}.
*
* @return the entity with the given id or {@literal Optional#empty()} if none found.
*
* @throws IllegalArgumentException if {@literal id} is {@literal null}.
*/
@Override
Optional findById(ID id);
/**
* Returns whether an entity with the given id exists.
*
* @param id must not be {@literal null}.
*
* @return {@literal true} if an entity with the given id exists, {@literal false} otherwise.
*
* @throws IllegalArgumentException if {@literal id} is {@literal null}.
*/
@Override
boolean existsById(ID id);
/**
* Returns the number of entities available.
*
* @return the number of entities.
*/
@Override
long count();
/**
* Deletes the entity with the given id.
*
* @param id must not be {@literal null}.
*
* @throws IllegalArgumentException in case the given {@literal id} is {@literal null}
*/
@Override
void deleteById(ID id);
/**
* Deletes a given entity.
*
* @param entity must not be {@literal null}.
*
* @throws IllegalArgumentException in case the given entity is {@literal null}.
*/
@Override
void delete(T entity);
/**
* Deletes the given entities.
*
* @param entities must not be {@literal null}. Must not contain {@literal null} elements.
*
* @throws IllegalArgumentException in case the given {@literal entities} or one of its entities is {@literal null}.
*/
@Override
void deleteAll(Iterable entities);
/**
* Deletes all entities managed by the repository.
*/
@Override
void deleteAll();
/**
* Returns a single entity matching the given {@link Example} or {@literal null} if none was found.
*
* @param example must not be {@literal null}.
*
* @return a single entity matching the given {@link Example} or {@link Optional#empty()} if none was found.
*
* @throws IncorrectResultSizeDataAccessException if the Example yields more than one result.
*/
@Override
Optional findOne(Example example);
/**
* Returns a {@link Page} of entities matching the given {@link Example}. In case no match could be found, an empty
* {@link Page} is returned.
*
* @param example must not be {@literal null}.
* @param pageable can be {@literal null}.
*
* @return a {@link Page} of entities matching the given {@link Example}.
*/
@Override
Page findAll(Example example, Pageable pageable);
/**
* Returns the number of instances matching the given {@link Example}.
*
* @param example the {@link Example} to count instances for. Must not be {@literal null}.
*
* @return the number of instances matching the {@link Example}.
*/
@Override
long count(Example example);
/**
* Checks whether the data store contains elements that match the given {@link Example}.
*
* @param example the {@link Example} to use for the existence check. Must not be {@literal null}.
*
* @return {@literal true} if the data store contains elements that match the given {@link Example}.
*/
@Override
boolean exists(Example example);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy