org.javastro.ivoa.jpa.Repository Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jaxbjpa-utils Show documentation
generic utilities to make using JAXB and JPA easier
The newest version!
package org.javastro.ivoa.jpa;
/*
 * Created on 12/08/2021 by Paul Harrison ([email protected]).
 */

import java.util.List;
import java.util.Optional;

/**
 * Definition of repository functionality.
 * @param  the type contained in the repository.
 * @param  the type of the key for the type contained in the repository.
 * @author Paul Harrison ([email protected]) 
 * @since 30 Dec 2021
 */
public interface Repository 
{

    /**
     * Saves a given entity. Use the returned instance for further operations as the save operation might have changed the
     * entity instance completely.
     *
     * @param  a sub-type of type contained in the repository.
     * @param entity must not be {@literal null}.
     * @return the saved entity will never be {@literal null}.
     */
     S create(S entity);

    /**
     * updates a given entity. Use the returned instance for further operations as the save operation might have changed the
     * entity instance completely.
     * 
     * @param  a sub-type of type contained in the repository.
     * @param entity must not be {@literal null}.
     * @return the saved entity will never be {@literal null}.
     */
     S update(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 {@code id} is {@literal null}.
     */
    Optional findById(ID id);

    /**
     * Returns all instances of the type.
     * @return all entities
     */
    Iterable findAll();
 
    /**
     * Returns Some instances of the type.
     * @param maxResults the number of results to return.
     * @param firstResult the index of the first result to return.
     * @return some entities
     */
     List findSome(int maxResults, int firstResult);

    
    /**
     * Deletes the entity with the given id.
     *
     * @param id must not be {@literal null}.
     * @throws IllegalArgumentException in case the given {@code id} is {@literal null}
     */
    void deleteById(ID id);

    /**
     * Deletes a given entity.
     *
     * @param entity the entity that should be destroyed
     * @throws IllegalArgumentException in case the given entity is {@literal null}.
     */
    void destroy(T entity);

        /**
     * Returns the number of entities available.
     *
     * @return the number of entities
     */
    long count();

}