mirror of
https://github.com/CarmJos/EasyConfiguration.git
synced 2026-06-04 10:38:19 +08:00
style: Reformatted code with .editorconfig
This commit is contained in:
+1
-1
@@ -342,5 +342,5 @@ tab_width = 2
|
|||||||
max_line_length = 120
|
max_line_length = 120
|
||||||
|
|
||||||
[*.md]
|
[*.md]
|
||||||
max_line_length = 0
|
max_line_length = 500
|
||||||
trim_trailing_whitespace = false
|
trim_trailing_whitespace = false
|
||||||
|
|||||||
@@ -8,167 +8,46 @@
|
|||||||

|

|
||||||

|

|
||||||
|
|
||||||
README
|
README LANGUAGES [ [**English**](README.md) | [中文](README_CN.md) ]
|
||||||
LANGUAGES [ [
|
|
||||||
*
|
|
||||||
*English
|
|
||||||
**](README.md) | [中文](README_CN.md) ]
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
# configured
|
# configured _(config framework)_
|
||||||
_(
|
|
||||||
config
|
|
||||||
framework)_
|
|
||||||
|
|
||||||
<img src=".doc/images/logo-bg.svg" width="150px" alt="logo" align="right" style="float: right"/>
|
<img src=".doc/images/logo-bg.svg" width="150px" alt="logo" align="right" style="float: right"/>
|
||||||
|
|
||||||
_
|
_**"Once set, Simple get."**_
|
||||||
*
|
|
||||||
*"
|
|
||||||
Once
|
|
||||||
set,
|
|
||||||
Simple
|
|
||||||
get."
|
|
||||||
**_
|
|
||||||
|
|
||||||
A
|
A simple, easy-to-use and universal solution for managing, loading, reading,
|
||||||
simple,
|
and updating configuration files.
|
||||||
easy-to-use
|
|
||||||
and
|
|
||||||
universal
|
|
||||||
solution
|
|
||||||
for
|
|
||||||
managing,
|
|
||||||
loading,
|
|
||||||
reading,
|
|
||||||
and
|
|
||||||
updating
|
|
||||||
configuration
|
|
||||||
files.
|
|
||||||
|
|
||||||
Supported
|
Supported **JSON**, **YAML**, **Hocon**, **TOML**, **SQL**, **MongoDB**... and much more!
|
||||||
*
|
|
||||||
*JSON
|
|
||||||
**,
|
|
||||||
*
|
|
||||||
*YAML
|
|
||||||
**,
|
|
||||||
*
|
|
||||||
*Hocon
|
|
||||||
**,
|
|
||||||
*
|
|
||||||
*TOML
|
|
||||||
**,
|
|
||||||
*
|
|
||||||
*SQL
|
|
||||||
**,
|
|
||||||
*
|
|
||||||
*MongoDB
|
|
||||||
**...
|
|
||||||
and
|
|
||||||
much
|
|
||||||
more!
|
|
||||||
|
|
||||||
## Features & Advantages
|
## Features & Advantages
|
||||||
|
|
||||||
Supported [YAML](providers/yaml), [JSON](providers/json), [HOCON](providers/hocon)
|
Supported [YAML](providers/yaml), [JSON](providers/json), [HOCON](providers/hocon) and [SQL](providers/sql)
|
||||||
and [SQL](providers/sql)
|
based configuration files format.
|
||||||
based
|
|
||||||
configuration
|
|
||||||
files
|
|
||||||
format.
|
|
||||||
|
|
||||||
-
|
- Class-based mechanism for initializing, loading, retrieving, and updating configuration files, ensuring convenience
|
||||||
Class-based
|
and efficiency.
|
||||||
mechanism
|
- Supports manual serialization and deserialization of complex configurations.
|
||||||
for
|
- Offers multiple builder forms for rapid construction of `ConfigValue<?>` objects.
|
||||||
initializing,
|
- Enables specification of configuration paths, comments, and more via annotations.
|
||||||
loading,
|
|
||||||
retrieving,
|
|
||||||
and
|
|
||||||
updating
|
|
||||||
configuration
|
|
||||||
files,
|
|
||||||
ensuring
|
|
||||||
convenience
|
|
||||||
and
|
|
||||||
efficiency.
|
|
||||||
-
|
|
||||||
Supports
|
|
||||||
manual
|
|
||||||
serialization
|
|
||||||
and
|
|
||||||
deserialization
|
|
||||||
of
|
|
||||||
complex
|
|
||||||
configurations.
|
|
||||||
-
|
|
||||||
Offers
|
|
||||||
multiple
|
|
||||||
builder
|
|
||||||
forms
|
|
||||||
for
|
|
||||||
rapid
|
|
||||||
construction
|
|
||||||
of
|
|
||||||
`ConfigValue<?>`
|
|
||||||
objects.
|
|
||||||
-
|
|
||||||
Enables
|
|
||||||
specification
|
|
||||||
of
|
|
||||||
configuration
|
|
||||||
paths,
|
|
||||||
comments,
|
|
||||||
and
|
|
||||||
more
|
|
||||||
via
|
|
||||||
annotations.
|
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
For
|
For the latest JavaDoc release, [CLICK HERE](https://CarmJos.github.io/configured).
|
||||||
the
|
|
||||||
latest
|
|
||||||
JavaDoc
|
|
||||||
release, [CLICK HERE](https://CarmJos.github.io/configured).
|
|
||||||
|
|
||||||
For
|
For a detailed development guide, [CLICK HERE](.doc/README.md).
|
||||||
a
|
|
||||||
detailed
|
|
||||||
development
|
|
||||||
guide, [CLICK HERE](.doc/README.md).
|
|
||||||
|
|
||||||
### Preview
|
### Preview
|
||||||
|
|
||||||
To
|
To quickly demonstrate the applicability of the project, here are a few practical demonstrations:
|
||||||
quickly
|
|
||||||
demonstrate
|
|
||||||
the
|
|
||||||
applicability
|
|
||||||
of
|
|
||||||
the
|
|
||||||
project,
|
|
||||||
here
|
|
||||||
are
|
|
||||||
a
|
|
||||||
few
|
|
||||||
practical
|
|
||||||
demonstrations:
|
|
||||||
|
|
||||||
- [Database configuration.](demo/src/main/java/cc/carm/lib/configuration/demo/DatabaseConfiguration.java)
|
- [Database configuration.](demo/src/main/java/cc/carm/lib/configuration/demo/DatabaseConfiguration.java)
|
||||||
- [Demonstration of configuration instance classes.](demo/src/main/java/cc/carm/lib/configuration/demo/tests/conf/DemoConfiguration.java)
|
- [Demonstration of configurations instance classes.](demo/src/main/java/cc/carm/lib/configuration/demo/tests/conf/DemoConfiguration.java)
|
||||||
|
|
||||||
Check
|
Check out all code demonstrations [HERE](demo/src/main/java/cc/carm/lib/configuration/demo/DatabaseConfiguration.java).
|
||||||
out
|
For more examples, see the [Development Guide](.doc/README.md).
|
||||||
all
|
|
||||||
code
|
|
||||||
demonstrations [HERE](demo/src/main/java/cc/carm/lib/configuration/demo/DatabaseConfiguration.java).
|
|
||||||
For
|
|
||||||
more
|
|
||||||
examples,
|
|
||||||
see
|
|
||||||
the [Development Guide](.doc/README.md).
|
|
||||||
|
|
||||||
```java
|
```java
|
||||||
|
|
||||||
@@ -361,104 +240,30 @@ dependencies {
|
|||||||
|
|
||||||
## Derived Projects
|
## Derived Projects
|
||||||
|
|
||||||
### [
|
### [**MineConfiguration**](https://github.com/CarmJos/MineConfiguration) (by @CarmJos)
|
||||||
*
|
|
||||||
*MineConfiguration
|
|
||||||
**](https://github.com/CarmJos/MineConfiguration) (by @CarmJos)
|
|
||||||
|
|
||||||
configured
|
configured for MineCraft!
|
||||||
for
|
Easily manage configurations on MineCraft-related server platforms.
|
||||||
MineCraft!
|
|
||||||
Easily
|
|
||||||
manage
|
|
||||||
configurations
|
|
||||||
on
|
|
||||||
MineCraft-related
|
|
||||||
server
|
|
||||||
platforms.
|
|
||||||
|
|
||||||
Currently,
|
Currently, it supports BungeeCord, Velocity, Bukkit (Spigot) servers,
|
||||||
it
|
with more platforms to be supported soon.
|
||||||
supports
|
|
||||||
BungeeCord,
|
|
||||||
Velocity,
|
|
||||||
Bukkit (
|
|
||||||
Spigot)
|
|
||||||
servers,
|
|
||||||
with
|
|
||||||
more
|
|
||||||
platforms
|
|
||||||
to
|
|
||||||
be
|
|
||||||
supported
|
|
||||||
soon.
|
|
||||||
|
|
||||||
## Support and Donation
|
## Support and Donation
|
||||||
|
|
||||||
If
|
If you appreciate this plugin, consider supporting me with a donation!
|
||||||
you
|
|
||||||
appreciate
|
|
||||||
this
|
|
||||||
plugin,
|
|
||||||
consider
|
|
||||||
supporting
|
|
||||||
me
|
|
||||||
with
|
|
||||||
a
|
|
||||||
donation!
|
|
||||||
|
|
||||||
Thank
|
Thank you for supporting open-source projects!
|
||||||
you
|
|
||||||
for
|
|
||||||
supporting
|
|
||||||
open-source
|
|
||||||
projects!
|
|
||||||
|
|
||||||
Many
|
Many thanks to Jetbrains for kindly providing a license for us to work on this and other open-source projects.
|
||||||
thanks
|
|
||||||
to
|
|
||||||
Jetbrains
|
|
||||||
for
|
|
||||||
kindly
|
|
||||||
providing
|
|
||||||
a
|
|
||||||
license
|
|
||||||
for
|
|
||||||
us
|
|
||||||
to
|
|
||||||
work
|
|
||||||
on
|
|
||||||
this
|
|
||||||
and
|
|
||||||
other
|
|
||||||
open-source
|
|
||||||
projects.
|
|
||||||
|
|
||||||
[](https://www.jetbrains.com/?from=https://github.com/CarmJos/configured)
|
[](https://www.jetbrains.com/?from=https://github.com/CarmJos/configured)
|
||||||
|
|
||||||
Many
|
Many thanks to [ArtformGames](https://github.com/ArtformGames) for their
|
||||||
thanks
|
strong support and active contribution to this project!
|
||||||
to [ArtformGames](https://github.com/ArtformGames)
|
|
||||||
for
|
|
||||||
their
|
|
||||||
strong
|
|
||||||
support
|
|
||||||
and
|
|
||||||
active
|
|
||||||
contribution
|
|
||||||
to
|
|
||||||
this
|
|
||||||
project!
|
|
||||||
|
|
||||||
<img src="https://raw.githubusercontent.com/ArtformGames/.github/master/logo/logo_full.svg" width="317px" height="117px" alt="ArtformGames">
|
<img src="https://raw.githubusercontent.com/ArtformGames/.github/master/logo/logo_full.svg" width="317px" height="117px" alt="ArtformGames">
|
||||||
|
|
||||||
## Open Source License
|
## Open Source License
|
||||||
|
|
||||||
This
|
This project's source code is licensed under
|
||||||
project's
|
|
||||||
source
|
|
||||||
code
|
|
||||||
is
|
|
||||||
licensed
|
|
||||||
under
|
|
||||||
the [GNU LESSER GENERAL PUBLIC LICENSE](https://www.gnu.org/licenses/lgpl-3.0.html).
|
the [GNU LESSER GENERAL PUBLIC LICENSE](https://www.gnu.org/licenses/lgpl-3.0.html).
|
||||||
|
|||||||
+16
-51
@@ -8,48 +8,30 @@
|
|||||||

|

|
||||||

|

|
||||||
|
|
||||||
README
|
README LANGUAGES [ [English](README.md) | [**中文**](README_CN.md) ]
|
||||||
LANGUAGES [ [English](README.md) | [
|
|
||||||
*
|
|
||||||
*中文
|
|
||||||
**](README_CN.md) ]
|
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
# configured
|
# configured _(配置文件框架)_
|
||||||
_(
|
|
||||||
配置文件框架)_
|
|
||||||
|
|
||||||
<img src=".doc/images/logo-bg.svg" width="150px" alt="logo" align="right" style="float: right"/>
|
<img src=".doc/images/logo-bg.svg" width="150px" alt="logo" align="right" style="float: right"/>
|
||||||
|
|
||||||
*
|
**一次配置,轻松读取!**
|
||||||
*一次配置,轻松读取!
|
|
||||||
**
|
|
||||||
|
|
||||||
一款简单便捷的通用配置文件加载、读取与更新工具,可自定义配置的格式。
|
一款简单便捷的通用配置文件加载、读取与更新工具,可自定义配置的格式。
|
||||||
|
|
||||||
## 特性 & 优势
|
## 特性 & 优势
|
||||||
|
|
||||||
支持 [YAML](providers/yaml), [JSON](providers/gson), [HOCON](providers/hocon)
|
支持 [YAML](providers/yaml), [JSON](providers/gson), [HOCON](providers/hocon) 和 [SQL](providers/sql) 等多种配置文件格式。
|
||||||
和 [SQL](providers/sql)
|
|
||||||
等多种配置文件格式。
|
|
||||||
|
|
||||||
-
|
- 基于类的配置文件初始化、加载、获取与更新机制,方便快捷。
|
||||||
基于类的配置文件初始化、加载、获取与更新机制,方便快捷。
|
- 支持复杂配置的手动序列化、反序列化。
|
||||||
-
|
- 提供多种builder形式,快速构建 `ConfigValue<?>` 对象。
|
||||||
支持复杂配置的手动序列化、反序列化。
|
- 支持通过注解规定配置对应的路径、注释等信息。
|
||||||
-
|
|
||||||
提供多种builder形式,快速构建
|
|
||||||
`ConfigValue<?>`
|
|
||||||
对象。
|
|
||||||
-
|
|
||||||
支持通过注解规定配置对应的路径、注释等信息。
|
|
||||||
|
|
||||||
## 开发
|
## 开发
|
||||||
|
|
||||||
详细开发介绍请 [点击这里](.doc/README.md) ,
|
详细开发介绍请 [点击这里](.doc/README.md) , JavaDoc(最新Release)
|
||||||
JavaDoc(
|
|
||||||
最新Release)
|
|
||||||
请 [点击这里](https://CarmJos.github.io/configured) 。
|
请 [点击这里](https://CarmJos.github.io/configured) 。
|
||||||
|
|
||||||
### 示例代码
|
### 示例代码
|
||||||
@@ -278,25 +260,12 @@ dependencies {
|
|||||||
|
|
||||||
## 衍生项目
|
## 衍生项目
|
||||||
|
|
||||||
### [
|
### [**MineConfiguration**](https://github.com/CarmJos/MineConfiguration) (by @CarmJos )
|
||||||
*
|
|
||||||
*MineConfiguration
|
|
||||||
**](https://github.com/CarmJos/MineConfiguration) (by @CarmJos )
|
|
||||||
|
|
||||||
configured
|
configured for MineCraft!
|
||||||
for
|
开始在 MineCraft 相关服务器平台上轻松(做)配置吧!
|
||||||
MineCraft!
|
|
||||||
开始在
|
|
||||||
MineCraft
|
|
||||||
相关服务器平台上轻松(
|
|
||||||
做)
|
|
||||||
配置吧!
|
|
||||||
|
|
||||||
目前支持
|
目前支持 BungeeCord, Bukkit(Spigot) 服务端,后续将支持更多平台。
|
||||||
BungeeCord,
|
|
||||||
Bukkit(
|
|
||||||
Spigot)
|
|
||||||
服务端,后续将支持更多平台。
|
|
||||||
|
|
||||||
## 支持与捐赠
|
## 支持与捐赠
|
||||||
|
|
||||||
@@ -304,18 +273,14 @@ Spigot)
|
|||||||
|
|
||||||
感谢您对开源项目的支持!
|
感谢您对开源项目的支持!
|
||||||
|
|
||||||
万分感谢
|
万分感谢 Jetbrains 为我们提供了从事此项目和其他开源项目的许可!
|
||||||
Jetbrains
|
|
||||||
为我们提供了从事此项目和其他开源项目的许可!
|
|
||||||
|
|
||||||
[](https://www.jetbrains.com/?from=https://github.com/CarmJos/configured)
|
[](https://www.jetbrains.com/?from=https://github.com/CarmJos/configured)
|
||||||
|
|
||||||
万分感谢来自 [ArtformGames](https://github.com/ArtformGames)
|
万分感谢来自 [ArtformGames](https://github.com/ArtformGames) 对本项目的大力支持与积极贡献!
|
||||||
对本项目的大力支持与积极贡献!
|
|
||||||
|
|
||||||
<img src="https://raw.githubusercontent.com/ArtformGames/.github/master/logo/logo_full.svg" width="317px" height="117px" alt="ArtformGames">
|
<img src="https://raw.githubusercontent.com/ArtformGames/.github/master/logo/logo_full.svg" width="317px" height="117px" alt="ArtformGames">
|
||||||
|
|
||||||
## 开源协议
|
## 开源协议
|
||||||
|
|
||||||
本项目源码采用 [GNU LESSER GENERAL PUBLIC LICENSE](https://www.gnu.org/licenses/lgpl-3.0.html)
|
本项目源码采用 [GNU LESSER GENERAL PUBLIC LICENSE](https://www.gnu.org/licenses/lgpl-3.0.html) 开源协议。
|
||||||
开源协议。
|
|
||||||
|
|||||||
Reference in New Issue
Block a user