src/main/java/de/uapcore/lightpit/dao/GenericDao.java

Mon, 01 Jun 2020 14:46:58 +0200

author
Mike Becker <universe@uap-core.de>
date
Mon, 01 Jun 2020 14:46:58 +0200
changeset 86
0a658e53177c
parent 75
33b6843fdf8a
permissions
-rw-r--r--

improves issue overview and adds progress information

universe@34 1 /*
universe@34 2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
universe@34 3 *
universe@34 4 * Copyright 2018 Mike Becker. All rights reserved.
universe@34 5 *
universe@34 6 * Redistribution and use in source and binary forms, with or without
universe@34 7 * modification, are permitted provided that the following conditions are met:
universe@34 8 *
universe@34 9 * 1. Redistributions of source code must retain the above copyright
universe@34 10 * notice, this list of conditions and the following disclaimer.
universe@34 11 *
universe@34 12 * 2. Redistributions in binary form must reproduce the above copyright
universe@34 13 * notice, this list of conditions and the following disclaimer in the
universe@34 14 * documentation and/or other materials provided with the distribution.
universe@34 15 *
universe@34 16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
universe@34 17 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
universe@34 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
universe@34 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
universe@34 20 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
universe@34 21 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
universe@34 22 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
universe@34 23 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
universe@34 24 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
universe@34 25 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
universe@34 26 * POSSIBILITY OF SUCH DAMAGE.
universe@34 27 *
universe@34 28 */
universe@34 29 package de.uapcore.lightpit.dao;
universe@34 30
universe@34 31 import java.sql.SQLException;
universe@34 32
universe@34 33 public interface GenericDao<T> {
universe@38 34
universe@38 35 /**
universe@47 36 * Finds an entity by its integer ID.
universe@75 37 * It is not guaranteed that referenced entities are automatically joined.
universe@47 38 *
universe@47 39 * @param id the id
universe@47 40 * @return the enity or null if there is no such entity
universe@47 41 * @throws SQLException on any kind of SQL errors
universe@47 42 */
universe@47 43 T find(int id) throws SQLException;
universe@47 44
universe@47 45 /**
universe@38 46 * Inserts an instance into database.
universe@75 47 * It is not guaranteed that generated fields will be updated in the instance.
universe@38 48 *
universe@38 49 * @param instance the instance to insert
universe@38 50 * @throws SQLException on any kind of SQL errors
universe@38 51 */
universe@38 52 void save(T instance) throws SQLException;
universe@38 53
universe@38 54 /**
universe@38 55 * Updates an instance in the database.
universe@38 56 *
universe@38 57 * @param instance the instance to insert
universe@38 58 * @return true if an instance has been updated, false if no instance with the specified ID was found
universe@38 59 * @throws SQLException on any kind of SQL errors
universe@38 60 */
universe@38 61 boolean update(T instance) throws SQLException;
universe@38 62
universe@38 63 /**
universe@38 64 * Inserts or updates an instance in the database.
universe@38 65 * Tries an update first and if that fails, performs a save.
universe@38 66 *
universe@38 67 * @param instance the instance to insert or update
universe@38 68 * @throws SQLException on any kind of SQL errors
universe@38 69 * @see #update(Object)
universe@38 70 * @see #save(Object)
universe@38 71 */
universe@38 72 default void saveOrUpdate(T instance) throws SQLException {
universe@38 73 if (!update(instance)) save(instance);
universe@38 74 }
universe@34 75 }

mercurial