1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/main/java/de/uapcore/lightpit/dao/RootEntityDao.java Thu Oct 15 13:31:52 2020 +0200
1.3 @@ -0,0 +1,83 @@
1.4 +/*
1.5 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
1.6 + *
1.7 + * Copyright 2018 Mike Becker. All rights reserved.
1.8 + *
1.9 + * Redistribution and use in source and binary forms, with or without
1.10 + * modification, are permitted provided that the following conditions are met:
1.11 + *
1.12 + * 1. Redistributions of source code must retain the above copyright
1.13 + * notice, this list of conditions and the following disclaimer.
1.14 + *
1.15 + * 2. Redistributions in binary form must reproduce the above copyright
1.16 + * notice, this list of conditions and the following disclaimer in the
1.17 + * documentation and/or other materials provided with the distribution.
1.18 + *
1.19 + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
1.20 + * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
1.21 + * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
1.22 + * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
1.23 + * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
1.24 + * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
1.25 + * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
1.26 + * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
1.27 + * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
1.28 + * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
1.29 + * POSSIBILITY OF SUCH DAMAGE.
1.30 + *
1.31 + */
1.32 +package de.uapcore.lightpit.dao;
1.33 +
1.34 +import java.sql.SQLException;
1.35 +import java.util.List;
1.36 +
1.37 +public interface RootEntityDao<T> {
1.38 +
1.39 + /**
1.40 + * Lists all entities.
1.41 + * @return a list of all entities
1.42 + * @throws SQLException on any kind of SQL errors
1.43 + */
1.44 + List<T> list() throws SQLException;
1.45 +
1.46 + /**
1.47 + * Finds an entity by its integer ID.
1.48 + * It is not guaranteed that referenced entities are automatically joined.
1.49 + *
1.50 + * @param id the id
1.51 + * @return the enity or null if there is no such entity
1.52 + * @throws SQLException on any kind of SQL errors
1.53 + */
1.54 + T find(int id) throws SQLException;
1.55 +
1.56 + /**
1.57 + * Inserts an instance into database.
1.58 + * It is not guaranteed that generated fields will be updated in the instance.
1.59 + *
1.60 + * @param instance the instance to insert
1.61 + * @throws SQLException on any kind of SQL errors
1.62 + */
1.63 + void save(T instance) throws SQLException;
1.64 +
1.65 + /**
1.66 + * Updates an instance in the database.
1.67 + *
1.68 + * @param instance the instance to insert
1.69 + * @return true if an instance has been updated, false if no instance with the specified ID was found
1.70 + * @throws SQLException on any kind of SQL errors
1.71 + */
1.72 + boolean update(T instance) throws SQLException;
1.73 +
1.74 + /**
1.75 + * Inserts or updates an instance in the database.
1.76 + * Tries an update first and if that fails, performs a save.
1.77 + *
1.78 + * @param instance the instance to insert or update
1.79 + * @throws SQLException on any kind of SQL errors
1.80 + * @see #update(Object)
1.81 + * @see #save(Object)
1.82 + */
1.83 + default void saveOrUpdate(T instance) throws SQLException {
1.84 + if (!update(instance)) save(instance);
1.85 + }
1.86 +}
