update version

Merge branch 'develop'
удалена ненужная зависимость
2021-01-05 19:04:28 +03:00 · 2021-01-05 19:03:32 +03:00 · 2021-01-05 19:03:21 +03:00 · 2021-01-05 18:59:24 +03:00 · 2021-01-05 18:22:31 +03:00 · 2021-01-05 18:20:09 +03:00
9 changed files with 785 additions and 126 deletions
--- a/README.MD
+++ b/README.MD
@@ -0,0 +1,636 @@
+# GHAST TOOLS
+
+![version: 1.10](https://img.shields.io/badge/version-1.10-0a0.svg?style=flat)
+![bukkit-api: 1.12](https://img.shields.io/badge/bukkit--api-1.12-d50.svg?style=flat)
+
+Набор вспомогательных инструментов для Bukkit API.  
+_Основан на версии Bukkit API 1.12._
+
+## Содержание
+
+1. [Перед использованием](#перед-использованием)
+2. [GhastTools](#ghasttools)
+3. [AssetsManager](#assetsmanager)
+4. [BuildHelper](#buildhelper)
+5. [CommandManager](#commandmanager)
+6. [EffectsHelper](#effectshelper)
+7. [EventContext](#eventcontext)
+8. [JdbcTemplate](#jdbctemplate)
+9. [ScheduleManager](#schedulemanager)
+10. [ScheduleTask](#scheduletask)
+11. [I18n](#i18n)
+12. [XLog](#xlog)
+13. [Подключение](#подключение)
+    1. [Gradle](#gradle)
+    2. [Maven](#maven)
+
+---
+
+## Перед использованием
+
+Перед началом использования, необходимо в вашем Bukkit-плагине прописать подобный код:
+
+```java
+void onLoad() {
+    GhastTools.setPlugin(this);
+}
+```
+
+Это необходимо сделать, т.к. весь инструментарий основан на статических (static) методах.
+
+Все методы данного набора инструментов объеденены в классы, выполняющие роль группировщиков. 
+
+## GhastTools
+
+Методы общего назначения или без определённой группировки.
+
+### loadConfig
+
+Загрузка файла настроек плагина - `config.yml`.
+
+```java
+YamlConfiguration config = GhastTools.loadConfig();
+```
+
+По-умолчанию "гаст" пытается файл найти в папке плагина - `getDataFolder()`.
+Если файла там нет, то выгружает встроенный (имеющийся в `.jar` файле плагина) в эту папку и загружает его.
+
+```java
+YamlConfiguration config = GhastTools.loadConfig(false);
+```
+
+Если передать параметр `false`, то при отсутствии файла `config.yml` в папке плагина,
+будет загруден исключительно встроенный файл настроек.
+
+## AssetsManager
+
+Методы по работе с файлами плагина (_"ассетами"_).
+
+У каждой группы методов один и тот же набор входных параметров:
+
+- `resourceName` - наименование и путь к файлу в папке плагина
+- `defaultResourceName` - наименование и путь к файлу в плагине.  
+  _Опционально. По-умолчанию равнен `resourceName`_
+- `saveDefault` - необходимость скопировать содержимое файла из `defaultResourceName` в файл `resourceName`.  
+  _Опционально. По-умолчанию равен `true`_
+  
+Правила поиска файлов так же одинаков для каждой группы:
+
+- В начале файл ищется в папке плагина
+- Если файл отсутствует в папке плагина, то...
+    - если `defaultResourceName` не равен `null`...
+        - если `saveDefault` равен `true`, то файл из плагина будет выгружен в папку плагина и от туда загружен в память.
+        - если `saveDefault` равен `false`, то данные будут взяты из файлв в плагине.
+    - если `defaultResourceName` равен `null`, то будет брошено исключение `AssetsException` с описанием ошибки вида "Файл X не найден".
+
+### getAsInputStream
+
+```java
+InputStream inputStream = AssetsManager.getAsInputStream("translate.ru.yml", "translate.yml", false);
+```
+
+### getAsReader
+
+```java
+Reader reader = AssetsManager.getAsReader("translate.ru.yml", "translate.yml", false);
+```
+
+### getAsString
+
+```java
+String string = AssetsManager.getAsString("readme.txt", "readme.txt", StandardCharsets.UTF_8, false);
+```
+
+У этой группы есть дополнительный _опциональный_ параметр - `charset` - в котором указывается кодиривка получаемой строки.  
+_По-умолчанию равен `StandardCharsets.UTF_8`_
+
+## BuildHelper
+
+Набор методов облегчающих размецение объектов на карте.
+
+### placeSkull
+
+```java
+Location location = ...;
+Skull skull = BuildHelper.placeSkull(location, BlockFace.NORTH)
+```
+
+### placeSignWall
+
+```java
+Location location = ...;
+Sign signWall = BuildHelper.placeSignWall(location, BlockFace.NORTH)
+```
+
+## CommandManager
+
+Регистрация команд.
+
+Имеется два варианта использования: упрощённый
+
+```java
+CommandManager.register("start", (sender, args) -> sender.sendMessage("hello!"));
+```
+
+и подробный:
+
+```java
+CommandManager.create("start")
+        .useOnlyPlayer()
+        .executer((sender, args) -> sender.sendMessage("hello!"))
+        .register();
+```
+
+### register
+
+Упрощенная регистрация команды. Указывается лишь название команды и исполнитель.
+
+```java
+CommandManager.register("start", (sender, args) -> sender.sendMessage("hello!"));
+```
+
+### create
+
+Конструктор для подробного варианта регистрации команды.
+
+```java
+CommandManager.Builder builder = CommandManager.create("start");
+```
+
+### executer
+
+Указание исполнителя для команды
+
+```java
+CommandManager.Builder builder = CommandManager.create("start")
+        .executer((sender, args) -> sender.sendMessage("hello!"));
+```
+
+### onError
+
+Обработчик исключений
+
+```java
+CommandManager.Builder builder = CommandManager.create("start")
+        .onError((sender, commandName, args, exception) -> {
+            sender.sendMessage(ChatColor.RED + "Произошла ошибка при выполнении команды '" + commandName + "'.");
+            exception.printStackTrace();
+        });
+```
+
+### useOnlyPlayer
+
+Указание, что данную команду могут использовать только Игроки.
+Опционально можно указать сообщение, которое будет выводиться в консоль.  
+_Отменяет действие указателя `useOnlyConsole`_
+
+```java
+CommandManager.Builder builder = CommandManager.create("start")
+		.useOnlyPlayer("Команду могут использовать только игроки");
+```
+
+### useOnlyConsole
+
+Указание, что данную команду можно использовать только в консоле.
+Опционально можно указать сообщение, которое будет выводиться Игроку.  
+_Отменяет действие указателя `useOnlyPlayer`_
+
+```java
+CommandManager.Builder builder = CommandManager.create("start")
+		.useOnlyConsole(ChatColor.RED + "Команду можно использовать только в консоли");
+```
+
+### register
+
+Регистрация описанной в Конструкторе команды.
+
+```java
+CommandManager.create("start")
+        .useOnlyPlayer()
+        .executer((sender, args) -> sender.sendMessage("hello!"))
+        .register();
+```
+
+## EffectsHelper
+
+Набор методов для работы с эффектами.
+
+### playSound
+
+Воспроизвести звук.
+
+```java
+Location location = ...;
+EffectsHelper.playSound(location, Sound.AMBIENT_CAVE, 1.0f);
+```
+
+### particle
+
+Создание частиц.
+
+```java
+Location location = ...;
+EffectsHelper.particle(location, Particle.REDSTONE, 1.0d, 1.0d, 1.0d, 1.0d, 5);
+```
+
+## EventContext
+
+Регистрация группы обработчиков событий, объединённых общим условием выполнения.
+
+```java
+EventContext.create()
+        .filter(() -> Bukkit.getOnlinePlayers().size() > 10)
+        .onEvent(PlayerJoinEvent.class, event -> { event.getPlayer().kickPlayer("Max players"); });
+```
+
+### create
+
+Создание контекста событий.
+
+```java
+EventContext eventContext = EventContext.create();
+```
+
+### filter
+
+Условие, при котором будут срабатывать обработчики событий в данном контексте.
+
+```java
+EventContext.create()
+        .filter(() -> Bukkit.getOnlinePlayers().size() > 10)
+```
+
+### onEvent
+
+Указание события и его обработчика.  
+_Обработчик события регистрируется сразу же._
+
+```java
+EventContext.create()
+        .filter(() -> Bukkit.getOnlinePlayers().size() > 10)
+        .onEvent(PlayerJoinEvent.class, event -> event.getPlayer().kickPlayer("Max players"));
+```
+
+### cancelEvent
+
+Отменить событие.  
+_Обработчик события регистрируется сразу же._
+
+```java
+EventContext.create()
+        .cancelEvent(BlockPlaceEvent.class);
+```
+
+эквивалентен коду:
+
+```java
+EventContext.create()
+        .onEvent(BlockPlaceEvent.class, event -> event.setCancelled(true))
+```
+
+## JdbcTemplate
+
+Инструмент для упрощения работы с SQL базами данных, работающими через JDBC.
+
+Для начала потребуется создать объект `DataSource`
+
+```java
+// На примере MySQL
+MysqlDataSource dataSource = new MysqlDataSource();
+dataSource.setServerName("localhost");
+dataSource.setPort(3306);
+dataSource.setCharacterEncoding(StandardCharsets.UTF_8.name());
+dataSource.setDatabaseName("MyDataBase");
+dataSource.setUser("root");
+dataSource.setPassword("secret");
+```
+
+После чего создать `JdbcTemplate`
+
+```java
+JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSource);
+```
+
+### execute
+
+Выполнение SQL запроса без последующей обработки результатов выполнения.
+
+```java
+jdbcTemplate.execute("CREATE TABLE my_table (id int, name varchar(16));");
+```
+
+### query
+
+Выполнение SQL запроса и обработка его результатов.  
+Может возвращать любой тип объектов. 
+
+```java
+String name = jdbcTemplate.query("SELECT name FROM my_table LIMIT 0,1", resultSet -> {
+        if (resultSet.next()) {
+            return resultSet.getString("name");
+        } else {
+            return null;
+        }
+});
+```
+
+```java
+List<String> names = jdbcTemplate.query("SELECT name FROM my_table", resultSet -> {
+        if (resultSet.next()) {
+            List<String> list = new ArrayList<>();
+            do {
+                list.add(resultSet.getString("name"));
+            } while (resultSet.next());
+            return list;
+        } else {
+            return Collections.emptyList();
+        }
+});
+```
+
+### queryOne
+
+Выполнение SQL запроса с расчетом, что результат будет единичным либо не будет вовсе.  
+Возвращает `Optional`.
+
+```java
+Optional<String> optName = jdbcTemplate.queryOne("SELECT name FROM my_table WHERE name LIKE 'dmitriymx'", rs -> rs.getString("name"));
+```
+
+### queryList
+
+Выполнение SQL запроса и обработка результата как списка данных.  
+Возвращает `List`.
+
+```java
+List<String> names = jdbcTemplate.queryList("SELECT name FROM my_table", (resultSet, rowNum) -> resultSet.getString("name"));
+```
+
+### queryForMap
+
+Выполнение SQL запроса с расчетом, что результат будет единичным либо не будет вовсе.  
+Возвращает `Map<String, Object>`, где ключ — это наименование колонок таблицы, а значения — это значения в ячейках таблицы.
+
+```java
+Map<String, Object> map = jdbcTemplate.queryForMap("SELECT * FROM my_table LIMIT 0,1;");
+```
+
+### queryForMapList
+
+Выполнение SQL запроса и обработка результата как списка данных.  
+Возвращает `List<Map<String, Object>>`, где ключ — это наименование колонок таблицы, а значения — это значения в ячейках таблицы.
+
+```java
+List<Map<String, Object>> mapList = jdbcTemplate.queryForMapList("SELECT * FROM my_table");
+```
+
+### update
+
+Выполнение SQL запроса где будет происходить обновление данных в таблице.
+Под "обновлением" подразумеваются любые изменения в таблице: `UPDATE`, `DELETE`, `INSERT`.  
+Возвращает число строк, которые были _по факту обновлены_ в таблице.
+
+```java
+int rows = jdbcTemplate.update("DELETE FROM my_table WHERE name LIKE 'dmitriymx';");
+```
+
+## ScheduleManager
+
+Набор методов для создания параллельных задач, выполняющихся один раз или по рассписанию.
+
+### createTask
+
+Создание конструктора задачи.
+
+```java
+ScheduleManager.Builder builder = ScheduleManager.createTask();
+```
+
+### useBukkitScheduler
+
+Если задача будет взаимодействоватьс **Bukkit API** или необходима привязка задачи к _тикам_,
+то необходимо использовать данный указатель.
+
+В ином случае, указатель не нужен.
+
+```java
+ScheduleManager.Builder builder = ScheduleManager.createTask()
+        .useBukkitScheduler();
+```
+
+### after
+
+Указание, что задачу нужно выполнить не сразу, а с некоторой задержкой перед запуском.
+
+```java
+ScheduleManager.Builder builder = ScheduleManager.createTask()
+        .after(5, TimeUnit.MINUTES);
+```
+
+### every
+
+Указание, что задачу нужно повторять через указанное время.
+
+```java
+ScheduleManager.Builder builder = ScheduleManager.createTask()
+        .every(5, TimeUnit.MINUTES);
+```
+
+### create
+
+Создание описанной задачи.
+
+```java
+ScheduleTask scheduleTask = ScheduleManager.createTask()
+        .every(1, TimeUnit.SECONDS)
+        .create(() -> Bukkit.getServer().getLogger().info("TimeMS: " + System.currentTimeMillis()));
+```
+
+_Задача будет только создана. Для её выполнения нужно вызвать `scheduleTask.start()`._
+
+### execute
+
+Создание и выполнение описанной задачи.
+
+```java
+ScheduleTask scheduleTask = ScheduleManager.createTask()
+        .every(1, TimeUnit.SECONDS)
+        .execute(() -> Bukkit.getServer().getLogger().info("TimeMS: " + System.currentTimeMillis()));
+```
+
+## ScheduleTask
+
+Вспомогательный объект, созданный через `ScheduleManager`. Позволяет управлять созданной задачей.
+
+### start
+
+Запускает задачу, если она еще не запущена.
+
+```java
+ScheduleTask scheduleTask = ...;
+scheduleTask.start();
+```
+
+### isCanceled
+
+Возвращает состояние задачи. Если `true`, значит задача была или _отменена/остоновлена_ или была завершена.
+
+```java
+ScheduleTask scheduleTask = ...;
+boolean status = scheduleTask.isCanceled();
+```
+
+### cancel
+
+Отменяет/Остонавливает выполнение задачи.
+
+```java
+ScheduleTask scheduleTask = ...;
+scheduleTask.cancel();
+```
+
+## I18n
+
+Инструмент для работы с мультиязыковыми сообщениями или просто сообщениями, которые храняться в отдельном файле.
+
+Позволяет использовать шаблонизированные сообщения вида `Привет, {player}!`.
+
+### loadMessages
+
+Загрузка сообщений в инструмент.
+
+Передать можно как "мапу" с перечислением ключ-сообщение, так и `Reader` на файл в формате `key=message` (как у `Properties`).
+
+```java
+Map<String, String> messagesMap = ...;
+I18n.loadMessages(messagesMap);
+```
+
+```java
+Reader reader = AssetsManager.getAsReader("messages.properties");
+I18n.loadMessages(reader);
+```
+
+В первом параметре можно указать код языка, для которого загружаются сообщения. По-умолчанию будет "en".
+
+```java
+Map<String, String> enMessagesMap = ...;
+Map<String, String> ruMessagesMap = ...;
+
+I18n.loadMessages("en", enMessagesMap);
+I18n.loadMessages("ru", ruMessagesMap);
+```
+
+```java
+Reader readerEn = AssetsManager.getAsReader("messages.properties");
+Reader readerRu = AssetsManager.getAsReader("messages.ru.properties");
+
+I18n.loadMessages("en", readerEn);
+I18n.loadMessages("ru", readerRu);
+```
+
+### get
+
+Получение сообщения по его ключу.  
+
+```java
+String msg = I18n.get("player.join.msg");
+```
+
+Если следующим сообщением указать `Map<String, Object>`, то можно будет воспользоваться шаблонизатором.
+
+```java
+Map<String, String> messagesMap = new HashMap<>();
+messagesMap.put("player.join.msg", "Привет, {player}!");
+
+I18n.loadMessages(messagesMap);
+
+Map<String, String> params = new HashMap<>();
+params.put("player", event.getPlayer().getName());
+
+String msg = I18n.get("player.join.msg", params);
+```
+
+Однако можно создавать `Map<String, String> params` явно, а воспользоваться [paramBuilder()](#parambuilder)
+
+```java
+String msg = I18n.get("player.join.msg", I18n.paramBuilder()
+        .add("player", event.getPlayer().getName())
+        .build());
+```
+
+Можно первым параметром указать код языка.
+
+```java
+String msg = I18n.get("ru", "player.join.msg");
+```
+
+### paramBuilder
+
+Инструмент для параметизирования шаблонов сообщений.
+
+```java
+Map<String, Object> params = I18n.paramBuilder()
+        .add("player", event.getPlayer().getName())
+        .build();
+String msg = I18n.get("player.join.msg", params);
+```
+
+## XLog
+
+Замена стандартному `getLogger()`, который использует `java.utils.Logger` и не всегда удобен для логирования.
+
+Имеет 4 уровня логирования: `debug`, `info`, `warning`, `error`.
+
+Сообщения могут быть шаблонизированными. Синтаксис шаблонов — `java.text.MessageFormat`.
+
+Примеры:
+
+```java
+XLog.info("Hello");
+XLog.info("Player {0} join game", event.getPlayer().getName());
+
+XLog.error("ERROR!", exception);
+XLog.error("ERROR: {0}", exception.getMessage());
+// Для экранирования "{" нужно перед ней поставить "'".
+// А для использования "'" нужно их дублировать.
+XLog.error("ERROR ''{0}'' in Event '{{1}'}: {2}", exception.getClass(), event.getClass(), exception.getMessage());
+XLog.error("ERROR: {0}", exception.getMessage(), exception);
+```
+
+---
+
+## Подключение
+
+### Gradle
+
+```groovy
+repositories {
+    maven { url 'https://dmx-mc-project.gitlab.io/maven-repository/' }
+}
+```
+
+```groovy
+implementation group: 'ghast', name: 'ghast-tools', version: '1.10'
+```
+
+### Maven
+
+```xml
+<repositories>
+    <repository>
+        <id>dmx-mc-project</id>
+        <url>https://dmx-mc-project.gitlab.io/maven-repository/</url>
+    </repository>
+</repositories>
+```
+
+```xml
+<dependencies>
+    <dependency>
+        <groupId>ghast</groupId>
+        <artifactId>ghast-tools</artifactId>
+        <version>1.10</version>
+    </dependency>
+</dependencies>
+```
--- a/build.gradle
+++ b/build.gradle
@@ -30,7 +30,6 @@ ext {
            commons_text: 'org.apache.commons:commons-text:1.9',
            lombok: 'org.projectlombok:lombok:1.18.12',
            reflection_object: 'ru.dmitriymx:reflection-object:1.0-BETA',
-            mysql: 'mysql:mysql-connector-java:8.0.22',
            test: [
                    junit5: [
                            "org.junit.jupiter:junit-jupiter-api:$junitVersion",
@@ -66,7 +65,6 @@ dependencies {
    annotationProcessor libs.lombok

    compileOnly2 libs.bukkit
-    compileOnly libs.mysql
    implementation libs.commons_text
    implementation libs.reflection_object

--- a/gradle.properties
+++ b/gradle.properties
@@ -1,3 +1,3 @@
 projectGroup=ghast
 projectName=ghast-tools
-projectVersion=1.9
+projectVersion=1.10
--- a/src/main/java/ghast/database/DataAccessException.java
+++ b/src/main/java/ghast/database/DataAccessException.java
@@ -8,15 +8,6 @@ public class DataAccessException extends RuntimeException {

 	private String sql;

-	public DataAccessException(String msg) {
-		super(msg);
-	}
-
-	public DataAccessException(String msg, String sql) {
-		this(msg);
-		this.sql = sql;
-	}
-
 	public DataAccessException(String msg, Throwable cause) {
 		super(msg, cause);
 	}
--- a/src/main/java/ghast/database/EmptyResultDataAccessException.java
+++ b/src/main/java/ghast/database/EmptyResultDataAccessException.java
@@ -1,8 +0,0 @@
-package ghast.database;
-
-public class EmptyResultDataAccessException extends IncorrectResultSizeDataAccessException {
-
-	public EmptyResultDataAccessException(int expectedSize) {
-		super(expectedSize);
-	}
-}
--- a/src/main/java/ghast/database/IncorrectResultSizeDataAccessException.java
+++ b/src/main/java/ghast/database/IncorrectResultSizeDataAccessException.java
@@ -1,8 +0,0 @@
-package ghast.database;
-
-public class IncorrectResultSizeDataAccessException extends DataAccessException {
-
-	public IncorrectResultSizeDataAccessException(int expectedSize) {
-		super("Incorrect result size: expected " + expectedSize);
-	}
-}
--- a/src/main/java/ghast/database/JdbcOperations.java
+++ b/src/main/java/ghast/database/JdbcOperations.java
@@ -2,6 +2,7 @@ package ghast.database;

 import java.util.List;
 import java.util.Map;
+import java.util.Optional;

 public interface JdbcOperations {

@@ -9,15 +10,13 @@ public interface JdbcOperations {

 	<T> T query(String sql, ResultSetExtractor<T> rse) throws DataAccessException;

-	<T> List<T> query(String sql, RowMapper<T> rowMapper) throws DataAccessException;
+	<T> Optional<T> queryOne(String sql, ResultSetExtractor<T> rse) throws DataAccessException;

-	<T> T queryForObject(String sql, RowMapper<T> rowMapper) throws DataAccessException;
+	<T> List<T> queryList(String sql, RowMapper<T> rowMapper) throws DataAccessException;

 	Map<String, Object> queryForMap(String sql) throws DataAccessException;

-	List<Map<String, Object>> queryForList(String sql) throws DataAccessException;
+	List<Map<String, Object>> queryForMapList(String sql) throws DataAccessException;

 	int update(String sql) throws DataAccessException;
-
-	int delete(String sql) throws DataAccessException;
 }
--- a/src/main/java/ghast/database/JdbcTemplate.java
+++ b/src/main/java/ghast/database/JdbcTemplate.java
@@ -6,17 +6,16 @@ import lombok.NoArgsConstructor;
 import lombok.Setter;

 import javax.sql.DataSource;
+import java.sql.Date;
 import java.sql.*;
-import java.util.ArrayList;
-import java.util.LinkedHashMap;
-import java.util.List;
-import java.util.Map;
+import java.util.*;

@NoArgsConstructor
@Getter
@Setter
 public class JdbcTemplate implements JdbcOperations {

+	private static final String DBG_SQL_INFO = "Execute SQL: {0}";
 	private DataSource dataSource;

 	public JdbcTemplate(DataSource dataSource) {
@@ -25,7 +24,7 @@ public class JdbcTemplate implements JdbcOperations {

 	@Override
 	public void execute(String sql) throws DataAccessException {
-		XLog.debug("Execute SQL: {0}", sql);
+		XLog.debug(DBG_SQL_INFO, sql);

 		Connection connection = openConnection();
 		Statement statement = null;
@@ -42,7 +41,7 @@ public class JdbcTemplate implements JdbcOperations {

 	@Override
 	public <T> T query(String sql, ResultSetExtractor<T> rse) throws DataAccessException {
-		XLog.debug("Execute SQL: {0}", sql);
+		XLog.debug(DBG_SQL_INFO, sql);

 		Connection connection = openConnection();
 		Statement statement = null;
@@ -61,71 +60,74 @@ public class JdbcTemplate implements JdbcOperations {
 	}

 	@Override
-	public <T> List<T> query(String sql, final RowMapper<T> rowMapper) throws DataAccessException {
+	public <T> Optional<T> queryOne(String sql, ResultSetExtractor<T> rse) throws DataAccessException {
 		return query(sql, rs -> {
-			List<T> resultList = new ArrayList<>();
-			int rowNum = 0;
-			while (rs.next()) {
-				resultList.add(rowMapper.mapRow(rs, rowNum++));
+			if (rs.next()) {
+				return Optional.ofNullable(rse.extractData(rs));
+			} else {
+				return Optional.empty();
 			}
+		});
+	}
+
+	@Override
+	public <T> List<T> queryList(String sql, final RowMapper<T> rowMapper) throws DataAccessException {
+		return query(sql, rs -> {
+			List<T> resultList;
+			int rowNum = 0;
+			if (rs.next()) {
+				resultList = new ArrayList<>();
+
+				do {
+					resultList.add(rowMapper.mapRow(rs, rowNum++));
+				} while (rs.next());
+			} else {
+				resultList = Collections.emptyList();
+			}
+
 			return resultList;
 		});
 	}

 	@Override
-	public <T> T queryForObject(String sql, RowMapper<T> rowMapper) throws DataAccessException {
+	public Map<String, Object> queryForMap(String sql) throws DataAccessException {
 		return query(sql, rs -> {
 			if (rs.next()) {
-				T resultObj = rowMapper.mapRow(rs, 0);
+				ResultSetMetaData metaData = rs.getMetaData();
+				int columnCount = metaData.getColumnCount();

-				if (rs.next()) {
-					throw new IncorrectResultSizeDataAccessException(1);
-				}
-
-				return resultObj;
+				return rowToMap(columnCount, metaData, rs);
 			} else {
-				throw new EmptyResultDataAccessException(1);
+				return Collections.emptyMap();
 			}
 		});
 	}

 	@Override
-	public Map<String, Object> queryForMap(String sql) throws DataAccessException {
-		return queryForObject(sql, (rs, rowNum) -> {
-			ResultSetMetaData metaData = rs.getMetaData();
-			int columnCount = metaData.getColumnCount();
-			Map<String, Object> resultMap = new LinkedHashMap<>(columnCount);
+	public List<Map<String, Object>> queryForMapList(String sql) throws DataAccessException {
+		return query(sql, rs -> {
+			List<Map<String, Object>> resultList;

-			for (int i = 1; i <= columnCount; i++) {
-				String key = lookupColumnName(metaData, i);
-				Object value = getResultSetRawValue(rs, i);
-				resultMap.put(key, value);
+			if (rs.next()) {
+				resultList = new ArrayList<>();
+
+				ResultSetMetaData metaData = rs.getMetaData();
+				int columnCount = metaData.getColumnCount();
+
+				do {
+					resultList.add(rowToMap(columnCount, metaData, rs));
+				} while (rs.next());
+			} else {
+				resultList = Collections.emptyList();
 			}

-			return resultMap;
-		});
-	}
-
-	@Override
-	public List<Map<String, Object>> queryForList(String sql) throws DataAccessException {
-		return query(sql, (rs, rowNum) -> {
-			ResultSetMetaData metaData = rs.getMetaData();
-			int columnCount = metaData.getColumnCount();
-			Map<String, Object> resultMap = new LinkedHashMap<>(columnCount);
-
-			for (int i = 1; i <= columnCount; i++) {
-				String key = lookupColumnName(metaData, i);
-				Object value = getResultSetRawValue(rs, i);
-				resultMap.put(key, value);
-			}
-
-			return resultMap;
+			return resultList;
 		});
 	}

 	@Override
 	public int update(String sql) throws DataAccessException {
-		XLog.debug("Execute SQL: {0}", sql);
+		XLog.debug(DBG_SQL_INFO, sql);

 		Connection connection = openConnection();
 		Statement statement = null;
@@ -143,16 +145,10 @@ public class JdbcTemplate implements JdbcOperations {
 		}
 	}

-	@Override
-	public int delete(String sql) throws DataAccessException {
-		return update(sql);
-	}
-
 	private Connection openConnection() {
 		try {
 			return getDataSource().getConnection();
-		}
-		catch (SQLException ex) {
+		} catch (SQLException ex) {
 			throw new CannotGetJdbcConnectionException("Could not get JDBC Connection", ex);
 		}
 	}
@@ -165,13 +161,26 @@ public class JdbcTemplate implements JdbcOperations {
 		return name;
 	}

+	private Map<String, Object> rowToMap(int columnCount, ResultSetMetaData metaData, ResultSet rs) throws SQLException {
+		Map<String, Object> rowMap = new LinkedHashMap<>(columnCount);
+
+		for (int i = 1; i <= columnCount; i++) {
+			String key = lookupColumnName(metaData, i);
+			Object value = getResultSetRawValue(rs, i);
+			rowMap.put(key, value);
+		}
+
+		return rowMap;
+	}
+
 	private Object getResultSetRawValue(ResultSet resultSet, int index) throws SQLException {
 		Object obj = resultSet.getObject(index);
-		String className = null;
-		if (obj != null) {
-			className = obj.getClass().getName();
+		if (obj == null) {
+			return null;
 		}

+		String className = obj.getClass().getName();
+
 		if (obj instanceof Blob) {
 			Blob blob = (Blob) obj;
 			obj = blob.getBytes(1, (int) blob.length());
@@ -180,18 +189,16 @@ public class JdbcTemplate implements JdbcOperations {
 			obj = clob.getSubString(1, (int) clob.length());
 		} else if ("oracle.sql.TIMESTAMP".equals(className) || "oracle.sql.TIMESTAMPTZ".equals(className)) {
 			obj = resultSet.getTimestamp(index);
-		} else if (className != null && className.startsWith("oracle.sql.DATE")) {
+		} else if (className.startsWith("oracle.sql.DATE")) {
 			String metaDataClassName = resultSet.getMetaData().getColumnClassName(index);
 			if ("java.sql.Timestamp".equals(metaDataClassName) || "oracle.sql.TIMESTAMP".equals(metaDataClassName)) {
 				obj = resultSet.getTimestamp(index);
-			}
-			else {
+			} else {
 				obj = resultSet.getDate(index);
 			}
-		} else if (obj instanceof Date) {
-			if ("java.sql.Timestamp".equals(resultSet.getMetaData().getColumnClassName(index))) {
-				obj = resultSet.getTimestamp(index);
-			}
+		} else if (obj instanceof Date
+				&& "java.sql.Timestamp".equals(resultSet.getMetaData().getColumnClassName(index))) {
+			obj = resultSet.getTimestamp(index);
 		}

 		return obj;
--- a/src/test/java/ghast/database/JdbcTemplateTest.java
+++ b/src/test/java/ghast/database/JdbcTemplateTest.java
@@ -17,6 +17,7 @@ import java.sql.SQLException;
 import java.text.MessageFormat;
 import java.util.List;
 import java.util.Map;
+import java.util.Optional;
 import java.util.StringJoiner;
 import java.util.logging.Logger;
 import java.util.stream.Collectors;
@@ -84,7 +85,7 @@ class JdbcTemplateTest {
 	}

 	@Test
-	void testQuery_Single() {
+	void testQuery_Simple_Single() {
 		String sql = MessageFormat.format("SELECT {2} FROM {0} WHERE {1} LIKE ''{3}''",
 				TABLE_NAME, COLUMN_NAME, COLUMN_VALUE, DATA[0][0]);

@@ -100,44 +101,41 @@ class JdbcTemplateTest {
 	}

 	@Test
-	void testQuery_List() {
+	void testQuery_Simple_Optional() {
+		String sql = MessageFormat.format("SELECT {2} FROM {0} WHERE {1} LIKE ''{3}''",
+				TABLE_NAME, COLUMN_NAME, COLUMN_VALUE, DATA[0][0]);
+
+		Optional<Integer> optValue = jdbcTemplate.queryOne(sql, rs -> rs.getInt(1));
+
+		assertTrue(optValue.isPresent());
+		assertEquals(DATA[0][1], optValue.get());
+	}
+
+	@Test
+	void testQuery_Simple_List() {
 		String sql = MessageFormat.format("SELECT {2} FROM {0} WHERE {1} LIKE ''{3}'' OR {1} LIKE ''{4}''",
 				TABLE_NAME, COLUMN_NAME, COLUMN_VALUE, DATA[0][0], DATA[1][0]);

-		List<Integer> listValues = jdbcTemplate.query(sql, (rs, rowNum) -> rs.getInt(1));
+		List<Integer> listValues = jdbcTemplate.queryList(sql, (rs, rowNum) -> rs.getInt(1));

 		assertIterableEquals(Lists.newArrayList(DATA[0][1], DATA[1][1]), listValues);
 	}

 	@Test
-	void testQueryForObject() {
-		class Player {
-			String name;
-			int value;
-
-			@Override
-			public boolean equals(Object o) {
-				if (this == o) return true;
-				if (!(o instanceof Player)) return false;
-				Player player = (Player) o;
-				return new EqualsBuilder().append(value, player.value).append(name, player.name).isEquals();
-			}
-
-			@Override
-			public int hashCode() {
-				return new HashCodeBuilder(17, 37).append(name).append(value).toHashCode();
-			}
-		}
-
+	void testQuery_Object_Single() {
 		String sql = MessageFormat.format("SELECT {1}, {2} FROM {0} WHERE {1} LIKE ''{3}''",
 				TABLE_NAME, COLUMN_NAME, COLUMN_VALUE, DATA[0][0]);

-		Player actualPlayer = jdbcTemplate.queryForObject(sql, (rs, rowNum) -> {
-			Player player0 = new Player();
-			player0.name = rs.getString(COLUMN_NAME);
-			player0.value = rs.getInt(COLUMN_VALUE);
+		Player actualPlayer = jdbcTemplate.query(sql, rs -> {
+			if (rs.next()) {
+				Player player0 = new Player();
+				player0.name = rs.getString(COLUMN_NAME);
+				player0.value = rs.getInt(COLUMN_VALUE);

-			return player0;
+				return player0;
+			} else {
+				return null;
+			}
 		});

 		Player expectedPlayer = new Player();
@@ -147,6 +145,34 @@ class JdbcTemplateTest {
 		assertEquals(expectedPlayer, actualPlayer);
 	}

+	@Test
+	void testQuery_Object_List() {
+		String sql = MessageFormat.format("SELECT {1}, {2} FROM {0}",
+				TABLE_NAME, COLUMN_NAME, COLUMN_VALUE);
+
+		List<Player> actualPlayers = jdbcTemplate.queryList(sql, (rs, num) -> {
+			Player player0 = new Player();
+			player0.name = rs.getString(COLUMN_NAME);
+			player0.value = rs.getInt(COLUMN_VALUE);
+
+			return player0;
+		});
+
+
+		List<Player> expectedPlayers = Stream.of(DATA)
+				.map(datum -> {
+					Player player1 = new Player();
+					player1.name = (String) datum[0];
+					player1.value = (int) datum[1];
+
+					return player1;
+				})
+				.collect(Collectors.toList());
+
+
+		assertIterableEquals(expectedPlayers, actualPlayers);
+	}
+
 	@Test
 	void testQueryForMap() {
 		String sql = MessageFormat.format("SELECT {1}, {2} FROM {0} WHERE {1} LIKE ''{3}''",
@@ -162,11 +188,11 @@ class JdbcTemplateTest {
 	}

 	@Test
-	void testQueryForList() {
+	void testQueryForMapList() {
 		String sql = MessageFormat.format("SELECT {1}, {2} FROM {0}",
 				TABLE_NAME, COLUMN_NAME, COLUMN_VALUE);

-		List<Map<String, Object>> actualMapList = jdbcTemplate.queryForList(sql);
+		List<Map<String, Object>> actualMapList = jdbcTemplate.queryForMapList(sql);

 		List<Map<String, Object>> expectedMapList = Stream.of(DATA)
 				.map(datum -> ImmutableMap.of(COLUMN_NAME, datum[0], COLUMN_VALUE, datum[1]))
@@ -211,6 +237,24 @@ class JdbcTemplateTest {
 		jdbcTemplate.execute("DROP TABLE IF EXISTS " + TABLE_NAME);
 	}

+	class Player {
+		String name;
+		int value;
+
+		@Override
+		public boolean equals(Object o) {
+			if (this == o) return true;
+			if (!(o instanceof Player)) return false;
+			Player player = (Player) o;
+			return new EqualsBuilder().append(value, player.value).append(name, player.name).isEquals();
+		}
+
+		@Override
+		public int hashCode() {
+			return new HashCodeBuilder(17, 37).append(name).append(value).toHashCode();
+		}
+	}
+
 	@Nested
 	class JdbcTemplateTest_ExecuteTestCase {
Author	SHA1	Message	Date
DmitriyMX	d34e418dcc	update version	2021-01-05 19:04:28 +03:00
DmitriyMX	bcca590741	Merge branch 'develop'	2021-01-05 19:03:32 +03:00
DmitriyMX	c47bb2093e	удалена ненужная зависимость	2021-01-05 19:03:21 +03:00
DmitriyMX	64c4f20d97	Merge branch 'dev/docs' into develop	2021-01-05 18:59:24 +03:00
DmitriyMX	89bca95d9f	update README.MD	2021-01-05 18:22:31 +03:00
DmitriyMX	897045b8d2	fix README.MD	2021-01-05 18:20:09 +03:00
DmitriyMX	0a648b7a5d	fix README.MD	2021-01-05 18:18:29 +03:00
DmitriyMX	b1615e258e	update README.MD	2021-01-05 18:17:27 +03:00
DmitriyMX	1e529d9d55	update README.MD	2021-01-05 17:40:43 +03:00
DmitriyMX	9929b0af18	fix README.MD	2021-01-05 17:29:36 +03:00
DmitriyMX	d63b9a085c	update README.MD	2021-01-05 17:28:51 +03:00
DmitriyMX	8e20d31227	update README.MD	2021-01-05 17:13:15 +03:00
DmitriyMX	1c1075e2dc	add README.MD	2021-01-04 02:17:44 +03:00
DmitriyMX	9d65461f1d	Merge branch 'feature/jdbctemplate' into develop	2021-01-03 16:15:44 +03:00
DmitriyMX	3037aed8ef	убран лишний код	2021-01-03 16:09:24 +03:00
DmitriyMX	f821691308	JdbcTemplate: add queryOne method	2021-01-03 16:07:40 +03:00
DmitriyMX	c963c4bd60	JdbcTemplate: refactoring	2021-01-03 16:00:34 +03:00