Fri, 22 May 2020 16:21:59 +0200
some reformatting
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@47 | 37 | * |
universe@47 | 38 | * @param id the id |
universe@47 | 39 | * @return the enity or null if there is no such entity |
universe@47 | 40 | * @throws SQLException on any kind of SQL errors |
universe@47 | 41 | */ |
universe@47 | 42 | T find(int id) throws SQLException; |
universe@47 | 43 | |
universe@47 | 44 | /** |
universe@38 | 45 | * Inserts an instance into database. |
universe@38 | 46 | * |
universe@38 | 47 | * @param instance the instance to insert |
universe@38 | 48 | * @throws SQLException on any kind of SQL errors |
universe@38 | 49 | */ |
universe@38 | 50 | void save(T instance) throws SQLException; |
universe@38 | 51 | |
universe@38 | 52 | /** |
universe@38 | 53 | * Updates an instance in the database. |
universe@38 | 54 | * |
universe@38 | 55 | * @param instance the instance to insert |
universe@38 | 56 | * @return true if an instance has been updated, false if no instance with the specified ID was found |
universe@38 | 57 | * @throws SQLException on any kind of SQL errors |
universe@38 | 58 | */ |
universe@38 | 59 | boolean update(T instance) throws SQLException; |
universe@38 | 60 | |
universe@38 | 61 | /** |
universe@38 | 62 | * Inserts or updates an instance in the database. |
universe@38 | 63 | * Tries an update first and if that fails, performs a save. |
universe@38 | 64 | * |
universe@38 | 65 | * @param instance the instance to insert or update |
universe@38 | 66 | * @throws SQLException on any kind of SQL errors |
universe@38 | 67 | * @see #update(Object) |
universe@38 | 68 | * @see #save(Object) |
universe@38 | 69 | */ |
universe@38 | 70 | default void saveOrUpdate(T instance) throws SQLException { |
universe@38 | 71 | if (!update(instance)) save(instance); |
universe@38 | 72 | } |
universe@34 | 73 | } |