From 1c1075e2dcfeea5e13bfe43a6e9e1aac19aa32b1 Mon Sep 17 00:00:00 2001 From: DmitriyMX Date: Mon, 4 Jan 2021 02:17:44 +0300 Subject: [PATCH 1/9] add README.MD --- README.MD | 156 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 156 insertions(+) create mode 100644 README.MD diff --git a/README.MD b/README.MD new file mode 100644 index 0000000..4f8b65a --- /dev/null +++ b/README.MD @@ -0,0 +1,156 @@ +# GHAST TOOLS + +Набор вспомогательных инструментов для Bukkit API. +_Основан на версии Bukkit API 1.12._ + +## Использование + +Перед началом использования, необходимо в вашем 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(); +``` + +_TODO добавить описание подробного режима_ + +## Подключение + +### Gradle + +```groovy +repositories { + maven { url 'https://dmx-mc-project.gitlab.io/maven-repository/' } +} +``` + +```groovy +implementation group: 'ghast', name: 'ghast-tools', version: '1.9' +``` + +### Maven + +```xml + + + dmx-mc-project + https://dmx-mc-project.gitlab.io/maven-repository/ + + +``` + +```xml + + + ghast + ghast-tools + 1.9 + + +``` \ No newline at end of file From 8e20d3122749869bee2a7343aae0fff00b417bc9 Mon Sep 17 00:00:00 2001 From: DmitriyMX Date: Tue, 5 Jan 2021 17:13:15 +0300 Subject: [PATCH 2/9] update README.MD --- README.MD | 372 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 370 insertions(+), 2 deletions(-) diff --git a/README.MD b/README.MD index 4f8b65a..13233ca 100644 --- a/README.MD +++ b/README.MD @@ -101,7 +101,7 @@ Sign signWall = BuildHelper.placeSignWall(location, BlockFace.NORTH) ### CommandManager -Регистрация комманд. +Регистрация команд. Имеется два варианта использования: упрощённый @@ -118,7 +118,375 @@ CommandManager.create("start") .register(); ``` -_TODO добавить описание подробного режима_ +#### 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 names = jdbcTemplate.query("SELECT name FROM my_table", resultSet -> { + if (resultSet.next()) { + List list = new ArrayList<>(); + do { + list.add(resultSet.getString("name")); + } while (resultSet.next()); + return list; + } else { + return Collections.emptyList(); + } +}); +``` + +#### queryOne + +Выполнение SQL запроса с расчетом, что результат будет единичным либо не будет вовсе. +Возвращает `Optional`. + +```java +Optional optName = jdbcTemplate.queryOne("SELECT name FROM my_table WHERE name LIKE 'dmitriymx'", rs -> rs.getString("name")); +``` + +#### queryList + +Выполнение SQL запроса и обработка результата как списка данных. +Возвращает `List`. + +```java +List names = jdbcTemplate.queryList("SELECT name FROM my_table", (resultSet, rowNum) -> resultSet.getString("name")); +``` + +#### queryForMap + +Выполнение SQL запроса с расчетом, что результат будет единичным либо не будет вовсе. +Возвращает `Map`, где ключ — это наименование колонок таблицы, а значения — это значения в ячейках таблицы. + +```java +Map map = jdbcTemplate.queryForMap("SELECT * FROM my_table LIMIT 0,1;"); +``` + +#### queryForMapList + +Выполнение SQL запроса и обработка результата как списка данных. +Возвращает `List>`, где ключ — это наименование колонок таблицы, а значения — это значения в ячейках таблицы. + +```java +List> 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 + +TODO + +#### loadMessages + +TODO + +#### get + +TODO + +#### paramBuilder + +TODO + +### XLog + +TODO + +--- ## Подключение From d63b9a085c7617700d7ef202e61b1583631afdff Mon Sep 17 00:00:00 2001 From: DmitriyMX Date: Tue, 5 Jan 2021 17:28:51 +0300 Subject: [PATCH 3/9] update README.MD --- README.MD | 119 +++++++++++++++++++++++++++++++----------------------- 1 file changed, 69 insertions(+), 50 deletions(-) diff --git a/README.MD b/README.MD index 13233ca..ff178fe 100644 --- a/README.MD +++ b/README.MD @@ -1,9 +1,28 @@ # GHAST TOOLS +![version: 1.9](https://img.shields.io/badge/version-1.9-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) +--- + +## Перед использованием Перед началом использования, необходимо в вашем Bukkit-плагине прописать подобный код: @@ -17,11 +36,11 @@ void onLoad() { Все методы данного набора инструментов объеденены в классы, выполняющие роль группировщиков. -### GhastTools +## GhastTools Методы общего назначения или без определённой группировки. -#### loadConfig +### loadConfig Загрузка файла настроек плагина - `config.yml`. @@ -39,7 +58,7 @@ YamlConfiguration config = GhastTools.loadConfig(false); Если передать параметр `false`, то при отсутствии файла `config.yml` в папке плагина, будет загруден исключительно встроенный файл настроек. -### AssetsManager +## AssetsManager Методы по работе с файлами плагина (_"ассетами"_). @@ -60,19 +79,19 @@ YamlConfiguration config = GhastTools.loadConfig(false); - если `saveDefault` равен `false`, то данные будут взяты из файлв в плагине. - если `defaultResourceName` равен `null`, то будет брошено исключение `AssetsException` с описанием ошибки вида "Файл X не найден". -#### getAsInputStream +### getAsInputStream ```java InputStream inputStream = AssetsManager.getAsInputStream("translate.ru.yml", "translate.yml", false); ``` -#### getAsReader +### getAsReader ```java Reader reader = AssetsManager.getAsReader("translate.ru.yml", "translate.yml", false); ``` -#### getAsString +### getAsString ```java String string = AssetsManager.getAsString("readme.txt", "readme.txt", StandardCharsets.UTF_8, false); @@ -81,25 +100,25 @@ String string = AssetsManager.getAsString("readme.txt", "readme.txt", StandardCh У этой группы есть дополнительный _опциональный_ параметр - `charset` - в котором указывается кодиривка получаемой строки. _По-умолчанию равен `StandardCharsets.UTF_8`_ -### BuildHelper +## BuildHelper Набор методов облегчающих размецение объектов на карте. -#### placeSkull +### placeSkull ```java Location location = ...; Skull skull = BuildHelper.placeSkull(location, BlockFace.NORTH) ``` -#### placeSignWall +### placeSignWall ```java Location location = ...; Sign signWall = BuildHelper.placeSignWall(location, BlockFace.NORTH) ``` -### CommandManager +## CommandManager Регистрация команд. @@ -118,7 +137,7 @@ CommandManager.create("start") .register(); ``` -#### register +### register Упрощенная регистрация команды. Указывается лишь название команды и исполнитель. @@ -126,7 +145,7 @@ CommandManager.create("start") CommandManager.register("start", (sender, args) -> sender.sendMessage("hello!")); ``` -#### create +### create Конструктор для подробного варианта регистрации команды. @@ -134,7 +153,7 @@ CommandManager.register("start", (sender, args) -> sender.sendMessage("hello!")) CommandManager.Builder builder = CommandManager.create("start"); ``` -#### executer +### executer Указание исполнителя для команды @@ -143,7 +162,7 @@ CommandManager.Builder builder = CommandManager.create("start") .executer((sender, args) -> sender.sendMessage("hello!")); ``` -#### onError +### onError Обработчик исключений @@ -155,7 +174,7 @@ CommandManager.Builder builder = CommandManager.create("start") }); ``` -#### useOnlyPlayer +### useOnlyPlayer Указание, что данную команду могут использовать только Игроки. Опционально можно указать сообщение, которое будет выводиться в консоль. @@ -166,7 +185,7 @@ CommandManager.Builder builder = CommandManager.create("start") .useOnlyPlayer("Команду могут использовать только игроки"); ``` -#### useOnlyConsole +### useOnlyConsole Указание, что данную команду можно использовать только в консоле. Опционально можно указать сообщение, которое будет выводиться Игроку. @@ -177,7 +196,7 @@ CommandManager.Builder builder = CommandManager.create("start") .useOnlyConsole(ChatColor.RED + "Команду можно использовать только в консоли"); ``` -#### register +### register Регистрация описанной в Конструкторе команды. @@ -188,11 +207,11 @@ CommandManager.create("start") .register(); ``` -### EffectsHelper +## EffectsHelper Набор методов для работы с эффектами. -#### playSound +### playSound Воспроизвести звук. @@ -201,7 +220,7 @@ Location location = ...; EffectsHelper.playSound(location, Sound.AMBIENT_CAVE, 1.0f); ``` -#### particle +### particle Создание частиц. @@ -210,7 +229,7 @@ Location location = ...; EffectsHelper.particle(location, Particle.REDSTONE, 1.0d, 1.0d, 1.0d, 1.0d, 5); ``` -### EventContext +## EventContext Регистрация группы обработчиков событий, объединённых общим условием выполнения. @@ -220,7 +239,7 @@ EventContext.create() .onEvent(PlayerJoinEvent.class, event -> { event.getPlayer().kickPlayer("Max players"); }); ``` -#### create +### create Создание контекста событий. @@ -228,7 +247,7 @@ EventContext.create() EventContext eventContext = EventContext.create(); ``` -#### filter +### filter Условие, при котором будут срабатывать обработчики событий в данном контексте. @@ -237,7 +256,7 @@ EventContext.create() .filter(() -> Bukkit.getOnlinePlayers().size() > 10) ``` -#### onEvent +### onEvent Указание события и его обработчика. _Обработчик события регистрируется сразу же._ @@ -248,7 +267,7 @@ EventContext.create() .onEvent(PlayerJoinEvent.class, event -> event.getPlayer().kickPlayer("Max players")); ``` -#### cancelEvent +### cancelEvent Отменить событие. _Обработчик события регистрируется сразу же._ @@ -265,7 +284,7 @@ EventContext.create() .onEvent(BlockPlaceEvent.class, event -> event.setCancelled(true)) ``` -### JdbcTemplate +## JdbcTemplate Инструмент для упрощения работы с SQL базами данных, работающими через JDBC. @@ -288,7 +307,7 @@ dataSource.setPassword("secret"); JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSource); ``` -#### execute +### execute Выполнение SQL запроса без последующей обработки результатов выполнения. @@ -296,7 +315,7 @@ JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSource); jdbcTemplate.execute("CREATE TABLE my_table (id int, name varchar(16));"); ``` -#### query +### query Выполнение SQL запроса и обработка его результатов. Может возвращать любой тип объектов. @@ -325,7 +344,7 @@ List names = jdbcTemplate.query("SELECT name FROM my_table", resultSet - }); ``` -#### queryOne +### queryOne Выполнение SQL запроса с расчетом, что результат будет единичным либо не будет вовсе. Возвращает `Optional`. @@ -334,7 +353,7 @@ List names = jdbcTemplate.query("SELECT name FROM my_table", resultSet - Optional optName = jdbcTemplate.queryOne("SELECT name FROM my_table WHERE name LIKE 'dmitriymx'", rs -> rs.getString("name")); ``` -#### queryList +### queryList Выполнение SQL запроса и обработка результата как списка данных. Возвращает `List`. @@ -343,7 +362,7 @@ Optional optName = jdbcTemplate.queryOne("SELECT name FROM my_table WHER List names = jdbcTemplate.queryList("SELECT name FROM my_table", (resultSet, rowNum) -> resultSet.getString("name")); ``` -#### queryForMap +### queryForMap Выполнение SQL запроса с расчетом, что результат будет единичным либо не будет вовсе. Возвращает `Map`, где ключ — это наименование колонок таблицы, а значения — это значения в ячейках таблицы. @@ -352,7 +371,7 @@ List names = jdbcTemplate.queryList("SELECT name FROM my_table", (result Map map = jdbcTemplate.queryForMap("SELECT * FROM my_table LIMIT 0,1;"); ``` -#### queryForMapList +### queryForMapList Выполнение SQL запроса и обработка результата как списка данных. Возвращает `List>`, где ключ — это наименование колонок таблицы, а значения — это значения в ячейках таблицы. @@ -361,7 +380,7 @@ Map map = jdbcTemplate.queryForMap("SELECT * FROM my_table LIMIT List> mapList = jdbcTemplate.queryForMapList("SELECT * FROM my_table"); ``` -#### update +### update Выполнение SQL запроса где будет происходить обновление данных в таблице. Под "обновлением" подразумеваются любые изменения в таблице: `UPDATE`, `DELETE`, `INSERT`. @@ -371,11 +390,11 @@ List> mapList = jdbcTemplate.queryForMapList("SELECT * FROM int rows = jdbcTemplate.update("DELETE FROM my_table WHERE name LIKE 'dmitriymx';"); ``` -### ScheduleManager +## ScheduleManager Набор методов для создания параллельных задач, выполняющихся один раз или по рассписанию. -#### createTask +### createTask Создание конструктора задачи. @@ -383,7 +402,7 @@ int rows = jdbcTemplate.update("DELETE FROM my_table WHERE name LIKE 'dmitriymx' ScheduleManager.Builder builder = ScheduleManager.createTask(); ``` -#### useBukkitScheduler +### useBukkitScheduler Если задача будет взаимодействоватьс **Bukkit API** или необходима привязка задачи к _тикам_, то необходимо использовать данный указатель. @@ -395,7 +414,7 @@ ScheduleManager.Builder builder = ScheduleManager.createTask() .useBukkitScheduler(); ``` -#### after +### after Указание, что задачу нужно выполнить не сразу, а с некоторой задержкой перед запуском. @@ -404,7 +423,7 @@ ScheduleManager.Builder builder = ScheduleManager.createTask() .after(5, TimeUnit.MINUTES); ``` -#### every +### every Указание, что задачу нужно повторять через указанное время. @@ -413,7 +432,7 @@ ScheduleManager.Builder builder = ScheduleManager.createTask() .every(5, TimeUnit.MINUTES); ``` -#### create +### create Создание описанной задачи. @@ -425,7 +444,7 @@ ScheduleTask scheduleTask = ScheduleManager.createTask() _Задача будет только создана. Для её выполнения нужно вызвать `scheduleTask.start()`._ -#### execute +### execute Создание и выполнение описанной задачи. @@ -435,11 +454,11 @@ ScheduleTask scheduleTask = ScheduleManager.createTask() .execute(() -> Bukkit.getServer().getLogger().info("TimeMS: " + System.currentTimeMillis())); ``` -### ScheduleTask +## ScheduleTask Вспомогательный объект, созданный через `ScheduleManager`. Позволяет управлять созданной задачей. -#### start +### start Запускает задачу, если она еще не запущена. @@ -448,7 +467,7 @@ ScheduleTask scheduleTask = ...; scheduleTask.start(); ``` -#### isCanceled +### isCanceled Возвращает состояние задачи. Если `true`, значит задача была или _отменена/остоновлена_ или была завершена. @@ -457,7 +476,7 @@ ScheduleTask scheduleTask = ...; boolean status = scheduleTask.isCanceled(); ``` -#### cancel +### cancel Отменяет/Остонавливает выполнение задачи. @@ -466,23 +485,23 @@ ScheduleTask scheduleTask = ...; scheduleTask.cancel(); ``` -### I18n +## I18n TODO -#### loadMessages +### loadMessages TODO -#### get +### get TODO -#### paramBuilder +### paramBuilder TODO -### XLog +## XLog TODO From 9929b0af189913e08711b1e3781a2f62f2b36972 Mon Sep 17 00:00:00 2001 From: DmitriyMX Date: Tue, 5 Jan 2021 17:29:36 +0300 Subject: [PATCH 4/9] fix README.MD --- README.MD | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.MD b/README.MD index ff178fe..097649d 100644 --- a/README.MD +++ b/README.MD @@ -8,7 +8,7 @@ _Основан на версии Bukkit API 1.12._ --- -1. [Перед использованием](#перед_использованием) +1. [Перед использованием](#перед-использованием) 2. [GhastTools](#ghasttools) 3. [AssetsManager](#assetsmanager) 4. [BuildHelper](#buildhelper) From 1e529d9d55c0942ae76b8aaa7f7dc8728417cf37 Mon Sep 17 00:00:00 2001 From: DmitriyMX Date: Tue, 5 Jan 2021 17:40:43 +0300 Subject: [PATCH 5/9] update README.MD --- README.MD | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/README.MD b/README.MD index 097649d..19d681b 100644 --- a/README.MD +++ b/README.MD @@ -6,20 +6,24 @@ Набор вспомогательных инструментов для 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) +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) + --- ## Перед использованием From b1615e258e13412497ee5dc80f0c8d33e9db9902 Mon Sep 17 00:00:00 2001 From: DmitriyMX Date: Tue, 5 Jan 2021 18:17:27 +0300 Subject: [PATCH 6/9] update README.MD --- README.MD | 97 ++++++++++++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 92 insertions(+), 5 deletions(-) diff --git a/README.MD b/README.MD index 19d681b..dc9456c 100644 --- a/README.MD +++ b/README.MD @@ -491,23 +491,110 @@ scheduleTask.cancel(); ## I18n -TODO +Инструмент для работы с мультиязыковыми сообщениями или просто сообщениями, которые храняться в отдельном файле. + +Позволяет использовать шаблонизированные сообщения вида `Привет, {player}!`. ### loadMessages -TODO +Загрузка сообщений в инструмент. + +Передать можно как "мапу" с перечислением ключ-сообщение, так и `Reader` на файл в формате `key=message` (как у `Properties`). + +```java +Map messagesMap = ...; +I18n.loadMessages(messagesMap); +``` + +```java +Reader reader = AssetsManager.getAsReader("messages.properties"); +I18n.loadMessages(reader); +``` + +В первом параметре можно указать код языка, для которого загружаются сообщения. По-умолчанию будет "en". + +```java +Map enMessagesMap = ...; +Map 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 -TODO +Получение сообщения по его ключу. + +```java +String msg = I18n.get("player.join.msg"); +``` + +Если следующим сообщением указать `Map`, то можно будет воспользоваться шаблонизатором. + +```java +Map messagesMap = new HashMap<>(); +messagesMap.put("player.join.msg", "Привет, {player}!"); + +I18n.loadMessages(messagesMap); + +Map params = new HashMap<>(); +params.put("player", event.getPlayer().getName()); + +String msg = I18n.get("player.join.msg", params); +``` + +Однако можно создавать `Map 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 -TODO +Инструмент для параметизирования шаблонов сообщений. + +```java +Map params = I18n.paramBuilder() + .add("player", event.getPlayer().getName()) + .build(); +String msg = I18n.get("player.join.msg", params); +``` ## XLog -TODO +Замена станрадтному `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); +``` --- From 0a648b7a5da734786b86fbd6aab9b0080b66a73c Mon Sep 17 00:00:00 2001 From: DmitriyMX Date: Tue, 5 Jan 2021 18:18:29 +0300 Subject: [PATCH 7/9] fix README.MD --- README.MD | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.MD b/README.MD index dc9456c..284d59c 100644 --- a/README.MD +++ b/README.MD @@ -551,7 +551,7 @@ params.put("player", event.getPlayer().getName()); String msg = I18n.get("player.join.msg", params); ``` -Однако можно создавать `Map params` явно, а воспользоваться [paramBuilder()](#paramBuilder) +Однако можно создавать `Map params` явно, а воспользоваться [paramBuilder()](#parambuilder) ```java String msg = I18n.get("player.join.msg", I18n.paramBuilder() From 897045b8d26e13de2c01b97ad301ca5114487928 Mon Sep 17 00:00:00 2001 From: DmitriyMX Date: Tue, 5 Jan 2021 18:20:09 +0300 Subject: [PATCH 8/9] fix README.MD --- README.MD | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.MD b/README.MD index 284d59c..08c317f 100644 --- a/README.MD +++ b/README.MD @@ -578,7 +578,7 @@ String msg = I18n.get("player.join.msg", params); ## XLog -Замена станрадтному `getLogger()`, который использует `java.utils.Logger` и не всегда удобен для логирования. +Замена стандартному `getLogger()`, который использует `java.utils.Logger` и не всегда удобен для логирования. Имеет 4 уровня логирования: `debug`, `info`, `warning`, `error`. From 89bca95d9f50281ee69b03788cba542b6e8c5160 Mon Sep 17 00:00:00 2001 From: DmitriyMX Date: Tue, 5 Jan 2021 18:22:31 +0300 Subject: [PATCH 9/9] update README.MD --- README.MD | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.MD b/README.MD index 08c317f..4972c77 100644 --- a/README.MD +++ b/README.MD @@ -592,7 +592,9 @@ 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}'' in Event '{{1}'}: {2}", exception.getClass(), event.getClass(), exception.getMessage()); XLog.error("ERROR: {0}", exception.getMessage(), exception); ```