com.wandrell.pattern.repository.Repository Maven / Gradle / Ivy
/**
* The MIT License (MIT)
*
* Copyright (c) 2014 the original author or authors.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*/
package com.wandrell.pattern.repository;
import java.util.Collection;
/**
* Interface for the repository pattern. Offers a way to apply CRUD operations
* into a collection of instances taken from a hidden source.
*
* This serves as a way to handle persistent data, without needing to know where
* that data persists.
*
* @author Bernardo Martínez Garrido
* @param
* the type stored on the repository
*/
public interface Repository {
/**
* Adds an entity to the repository.
*
* @param entity
* the entity to add
*/
public void add(final V entity);
/**
* Returns all the entities contained in the repository.
*
* @return all the entities contained in the repository
*/
public Collection getAll();
/**
* Removes an entity from the repository.
*
* @param entity
* the entity to remove
*/
public void remove(final V entity);
/**
* Updates an entity on the repository.
*
* @param entity
* the entity to update.
*/
public void update(final V entity);
}